Skip to content

README.md

Latest commit

 

History

History
50 lines (33 loc) · 2.16 KB

README.md

File metadata and controls

50 lines (33 loc) · 2.16 KB

dcctl — Documentation

If docs/demo.gif is missing, generate it with: vhs docs/demo.tape (from repo root; requires VHS and dcctl on PATH).

Sequence diagrams

Sequence diagrams for main flows (Mermaid format). View in any Markdown viewer that supports Mermaid (e.g. GitHub, VS Code with Mermaid extension, or Mermaid Live).

Diagram Description
01-config-and-up Load config, resolve environment and manifests, run docker compose up
02-down-and-cleanup Stop services, optional remove containers/volumes (down)
03-manifest-resolution How dcctl resolves config path, environment, and manifest file paths
04-image Image ls / pull / remove from current environment manifests
05-show-ports Extract and list published ports per service (where to connect)
06-manifests Write sample compose manifest into environment directory
07-volumes Volumes clean: list (by project or all), select, confirm, remove

Terminal demo (VHS)

A VHS tape records a short terminal demo of dcctl (help, version, config template).

Prerequisites

  • VHS: brew install vhs (or see project install docs)
  • dcctl binary on PATH (e.g. make build then export PATH="$PWD:$PATH" from repo root)

Render the demo

From the repository root (so dcctl resolves and paths match):

vhs docs/demo.tape

Output is written to docs/demo.gif (or the path set by Output in the tape). To produce MP4 instead, change the Output line in demo.tape to e.g. Output docs/demo.mp4 and run again.

Tape location

  • Tape file: docs/demo.tape
  • Rendered GIF (default): docs/demo.gif

Prompt / shell issues

If you see a broken prompt in the GIF, run VHS from bash so it does not inherit a complex zsh setup:

bash
vhs docs/demo.tape