mirror of https://github.com/basnijholt/compose-farm.git synced 2026-02-08 00:12:11 +00:00

Files

Bas Nijholt ec5115f793 docs: add documentation for config init --discover and config example

- Update docs/commands.md with new --discover flag and example subcommand
- Update docs/getting-started.md with discovery and example workflows
- Update README.md Config Command section
- Add VHS tape and demo video for cf config example

2025-12-21 22:53:50 -08:00

843 B

Raw Permalink Blame History

CLI Demo Recordings

VHS-based terminal demo recordings for Compose Farm CLI.

Requirements

VHS: go install github.com/charmbracelet/vhs@latest

Usage

# Record all demos
python docs/demos/cli/record.py

# Record specific demos
python docs/demos/cli/record.py quickstart migration

Demos

Tape	Description
`install.tape`	Installing with `uv tool install`
`quickstart.tape`	`cf ps`, `cf up`, `cf logs`
`logs.tape`	Viewing logs
`compose.tape`	`cf compose` passthrough (--help, images, exec)
`update.tape`	`cf update`
`migration.tape`	Service migration
`apply.tape`	`cf apply`
`config-example.tape`	`cf config example` - generate example stacks

Output

GIF and WebM files saved to docs/assets/.

843 B Raw Permalink Blame History