diff --git a/README.md b/README.md index 4e15814..37ccfe3 100644 --- a/README.md +++ b/README.md @@ -540,21 +540,21 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a ```yaml - Usage: cf up [OPTIONS] [STACKS]... + Usage: cf up [OPTIONS] [stacks]... Start stacks (docker compose up -d). Auto-migrates if host changed. ╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮ -│ [stacks]... TEXT Stacks to operate on │ +│ stacks Stacks to operate on │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --all -a Run on all stacks │ -│ --host -H TEXT Filter to stacks on this host │ -│ --service -s TEXT Target a specific service within the stack │ -│ --pull Pull images before starting (--pull always) │ -│ --build Build images before starting │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --all -a Run on all stacks │ +│ --host -H Filter to stacks on this host │ +│ --service -s Target a specific service within the stack │ +│ --pull Pull images before starting (--pull always) │ +│ --build Build images before starting │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -578,19 +578,19 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a ```yaml - Usage: cf down [OPTIONS] [STACKS]... + Usage: cf down [OPTIONS] [stacks]... Stop stacks (docker compose down). ╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮ -│ [stacks]... TEXT Stacks to operate on │ +│ stacks Stacks to operate on │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --all -a Run on all stacks │ -│ --orphaned Stop orphaned stacks (in state but removed from config) │ -│ --host -H TEXT Filter to stacks on this host │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --all -a Run on all stacks │ +│ --orphaned Stop orphaned stacks (in state but removed from config) │ +│ --host -H Filter to stacks on this host │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -614,19 +614,19 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a ```yaml - Usage: cf stop [OPTIONS] [STACKS]... + Usage: cf stop [OPTIONS] [stacks]... Stop services without removing containers (docker compose stop). ╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮ -│ [stacks]... TEXT Stacks to operate on │ +│ stacks Stacks to operate on │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --all -a Run on all stacks │ -│ --host -H TEXT Filter to stacks on this host │ -│ --service -s TEXT Target a specific service within the stack │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --all -a Run on all stacks │ +│ --host -H Filter to stacks on this host │ +│ --service -s Target a specific service within the stack │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -650,19 +650,19 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a ```yaml - Usage: cf pull [OPTIONS] [STACKS]... + Usage: cf pull [OPTIONS] [stacks]... Pull latest images (docker compose pull). ╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮ -│ [stacks]... TEXT Stacks to operate on │ +│ stacks Stacks to operate on │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --all -a Run on all stacks │ -│ --host -H TEXT Filter to stacks on this host │ -│ --service -s TEXT Target a specific service within the stack │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --all -a Run on all stacks │ +│ --host -H Filter to stacks on this host │ +│ --service -s Target a specific service within the stack │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -686,19 +686,19 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a ```yaml - Usage: cf restart [OPTIONS] [STACKS]... + Usage: cf restart [OPTIONS] [stacks]... Restart running containers (docker compose restart). ╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮ -│ [stacks]... TEXT Stacks to operate on │ +│ stacks Stacks to operate on │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --all -a Run on all stacks │ -│ --host -H TEXT Filter to stacks on this host │ -│ --service -s TEXT Target a specific service within the stack │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --all -a Run on all stacks │ +│ --host -H Filter to stacks on this host │ +│ --service -s Target a specific service within the stack │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -722,19 +722,19 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a ```yaml - Usage: cf update [OPTIONS] [STACKS]... + Usage: cf update [OPTIONS] [stacks]... Update stacks (pull + build + up). Shorthand for 'up --pull --build'. ╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮ -│ [stacks]... TEXT Stacks to operate on │ +│ stacks Stacks to operate on │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --all -a Run on all stacks │ -│ --host -H TEXT Filter to stacks on this host │ -│ --service -s TEXT Target a specific service within the stack │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --all -a Run on all stacks │ +│ --host -H Filter to stacks on this host │ +│ --service -s Target a specific service within the stack │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -776,12 +776,12 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a Use --full to also run 'up' on all stacks (picks up compose/env changes). ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --dry-run -n Show what would change without executing │ -│ --no-orphans Only migrate, don't stop orphaned stacks │ -│ --no-strays Don't stop stray stacks (running on wrong host) │ -│ --full -f Also run up on all stacks to apply config changes │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --dry-run -n Show what would change without executing │ +│ --no-orphans Only migrate, don't stop orphaned stacks │ +│ --no-strays Don't stop stray stacks (running on wrong host) │ +│ --full -f Also run up on all stacks to apply config changes │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -805,7 +805,7 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a ```yaml - Usage: cf compose [OPTIONS] STACK COMMAND [ARGS]... + Usage: cf compose [OPTIONS] {stack} {command} [args]... Run any docker compose command on a stack. @@ -820,14 +820,14 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a cf compose mystack config - view parsed config ╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮ -│ * stack TEXT Stack to operate on (use '.' for current dir) [required] │ -│ * command TEXT Docker compose command [required] │ -│ [args]... TEXT Additional arguments │ +│ * stack Stack to operate on (use '.' for current dir) [required] │ +│ * command Docker compose command [required] │ +│ args Additional arguments │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --host -H TEXT Filter to stacks on this host │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --host -H Filter to stacks on this host │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -853,19 +853,19 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a ```yaml - Usage: cf traefik-file [OPTIONS] [STACKS]... + Usage: cf traefik-file [OPTIONS] [stacks]... Generate a Traefik file-provider fragment from compose Traefik labels. ╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮ -│ [stacks]... TEXT Stacks to operate on │ +│ stacks Stacks to operate on │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --all -a Run on all stacks │ -│ --output -o PATH Write Traefik file-provider YAML to this path (stdout if │ -│ omitted) │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --all -a Run on all stacks │ +│ --output -o Write Traefik file-provider YAML to this path (stdout if │ +│ omitted) │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -889,7 +889,7 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a ```yaml - Usage: cf refresh [OPTIONS] [STACKS]... + Usage: cf refresh [OPTIONS] [stacks]... Update local state from running stacks. @@ -903,14 +903,14 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a Use 'cf apply' to make reality match your config (stop orphans, migrate). ╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮ -│ [stacks]... TEXT Stacks to operate on │ +│ stacks Stacks to operate on │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --all -a Run on all stacks │ -│ --config -c PATH Path to config file │ -│ --log-path -l PATH Path to Dockerfarm TOML log │ -│ --dry-run -n Show what would change without writing │ -│ --help -h Show this message and exit. │ +│ --all -a Run on all stacks │ +│ --config -c Path to config file │ +│ --log-path -l Path to Dockerfarm TOML log │ +│ --dry-run -n Show what would change without writing │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -935,7 +935,7 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a ```yaml - Usage: cf check [OPTIONS] [STACKS]... + Usage: cf check [OPTIONS] [stacks]... Validate configuration, traefik labels, mounts, and networks. @@ -945,12 +945,12 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a Use --local to skip SSH-based checks for faster validation. ╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮ -│ [stacks]... TEXT Stacks to operate on │ +│ stacks Stacks to operate on │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --local Skip SSH-based checks (faster) │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --local Skip SSH-based checks (faster) │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -975,7 +975,7 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a ```yaml - Usage: cf init-network [OPTIONS] [HOSTS]... + Usage: cf init-network [OPTIONS] [hosts]... Create Docker network on hosts with consistent settings. @@ -984,14 +984,14 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a consistent networking. ╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮ -│ [hosts]... TEXT Hosts to create network on (default: all) │ +│ hosts Hosts to create network on (default: all) │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --network -n TEXT Network name [default: mynetwork] │ -│ --subnet -s TEXT Network subnet [default: 172.20.0.0/16] │ -│ --gateway -g TEXT Network gateway [default: 172.20.0.1] │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --network -n Network name [default: mynetwork] │ +│ --subnet -s Network subnet [default: 172.20.0.0/16] │ +│ --gateway -g Network gateway [default: 172.20.0.1] │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -1091,21 +1091,21 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a ```yaml - Usage: cf logs [OPTIONS] [STACKS]... + Usage: cf logs [OPTIONS] [stacks]... Show stack logs. With --service, shows logs for just that service. ╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮ -│ [stacks]... TEXT Stacks to operate on │ +│ stacks Stacks to operate on │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --all -a Run on all stacks │ -│ --host -H TEXT Filter to stacks on this host │ -│ --service -s TEXT Target a specific service within the stack │ -│ --follow -f Follow logs │ -│ --tail -n INTEGER Number of lines (default: 20 for --all, 100 otherwise) │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --all -a Run on all stacks │ +│ --host -H Filter to stacks on this host │ +│ --service -s Target a specific service within the stack │ +│ --follow -f Follow logs │ +│ --tail -n Number of lines (default: 20 for --all, 100 otherwise) │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -1130,7 +1130,7 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a ```yaml - Usage: cf ps [OPTIONS] [STACKS]... + Usage: cf ps [OPTIONS] [stacks]... Show status of stacks. @@ -1140,14 +1140,14 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a With --service: filters to a specific service within the stack. ╭─ Arguments ────────────────────────────────────────────────────────────────────────────╮ -│ [stacks]... TEXT Stacks to operate on │ +│ stacks Stacks to operate on │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --all -a Run on all stacks │ -│ --host -H TEXT Filter to stacks on this host │ -│ --service -s TEXT Target a specific service within the stack │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --all -a Run on all stacks │ +│ --host -H Filter to stacks on this host │ +│ --service -s Target a specific service within the stack │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -1181,11 +1181,11 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a With --containers: Shows per-container resource stats (requires Glances). ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --live -l Query Docker for live container stats │ -│ --containers -C Show per-container resource stats (requires Glances) │ -│ --host -H TEXT Filter to stacks on this host │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --live -l Query Docker for live container stats │ +│ --containers -C Show per-container resource stats (requires Glances) │ +│ --host -H Filter to stacks on this host │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -1214,10 +1214,10 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a List all stacks and their assigned hosts. ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --host -H TEXT Filter to stacks on this host │ -│ --simple -s Plain output (one stack per line, for scripting) │ -│ --config -c PATH Path to config file │ -│ --help -h Show this message and exit. │ +│ --host -H Filter to stacks on this host │ +│ --simple -s Plain output (one stack per line, for scripting) │ +│ --config -c Path to config file │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ``` @@ -1248,10 +1248,10 @@ Full `--help` output for each command. See the [Usage](#usage) table above for a Start the web UI server. ╭─ Options ──────────────────────────────────────────────────────────────────────────────╮ -│ --host -H TEXT Host to bind to [default: 0.0.0.0] │ -│ --port -p INTEGER Port to listen on [default: 8000] │ -│ --reload -r Enable auto-reload for development │ -│ --help -h Show this message and exit. │ +│ --host -H Host to bind to [default: 0.0.0.0] │ +│ --port -p Port to listen on [default: 8000] │ +│ --reload -r Enable auto-reload for development │ +│ --help -h Show this message and exit. │ ╰────────────────────────────────────────────────────────────────────────────────────────╯ ```