Skip to content

docs: sync README command sections with the actual command tree - #77

Closed
noamloewenstern wants to merge 1 commit into
coollabsio:v4.xfrom
noamloewenstern:docs/readme-command-sync
Closed

docs: sync README command sections with the actual command tree#77
noamloewenstern wants to merge 1 commit into
coollabsio:v4.xfrom
noamloewenstern:docs/readme-command-sync

Conversation

@noamloewenstern

Copy link
Copy Markdown

Closes #76

The README's command sections had fallen behind the CLI. This syncs them with the actual command tree, verified by building from this branch and walking --help for every command group and subcommand (144 commands total).

Added:

  • project create
  • app create (public, github, deploy-key, dockerfile, dockerimage) with key flags
  • app previews delete
  • storage sections for app, database, and service
  • database env (list/get/create/update/delete/sync)
  • service create <type> and --list-types
  • version
  • a short section for the alpha init and firewall trees (feat(init,firewall): add WireGuard mesh bootstrap and coold firewall client (alpha, v5) #72), pointing to --help and llms-full.txt instead of duplicating their large flag surface

Fixed:

  • Global Flags: removed --host and -f, --force, which aren't global flags on the current build; --force stays documented per-command
  • database backup create: retention flag names (--retention-days-locally, --retention-max-storage-locally, --disable-local-backup, etc.)
  • service env sync: removed the --preview flag it doesn't have
  • env create/update/sync: added --runtime and --comment, noted the build-time/runtime defaults
  • private-key add: takes a plain file path, not @filename
  • deploy uuid/name/batch: --force has no -f shorthand (only deploy cancel does)

Also added app create and service create examples to the Examples section, adapted from the commands' own --help examples.

llms.txt/llms-full.txt: regenerated with go run ./coolify docs llms; no content changes, so they're not part of the diff.

Every line in the diff traces back to captured --help output; no invented flags.

Verified against --help output of a build from this branch:

- add project create, app create (public/github/deploy-key/dockerfile/
  dockerimage), app previews, app/database/service storage, database env,
  service create, and version
- add a short section for the alpha init and firewall command trees
- fix global flags: --host and -f/--force are not global flags on the
  current build
- fix database backup create retention flag names
- fix service env sync (no --preview there) and add --runtime/--comment
  to the env commands
- fix private-key add: it takes a plain file path, not @filename

llms.txt and llms-full.txt were regenerated with go run ./coolify docs
llms and had no content changes, so they are untouched.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@andrasbacsai

Copy link
Copy Markdown
Member

Superseded by #79, which applies the README sync to the current v4.x head and includes the generated catalog refresh required by CI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: README command list is missing the create commands, storage, previews, and database env

2 participants