docs: sync README command sections with the actual command tree - #77
Closed
noamloewenstern wants to merge 1 commit into
Closed
docs: sync README command sections with the actual command tree#77noamloewenstern wants to merge 1 commit into
noamloewenstern wants to merge 1 commit into
Conversation
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>
Member
|
Superseded by #79, which applies the README sync to the current v4.x head and includes the generated catalog refresh required by CI. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
--helpfor every command group and subcommand (144 commands total).Added:
project createapp create(public, github, deploy-key, dockerfile, dockerimage) with key flagsapp previews deletedatabase env(list/get/create/update/delete/sync)service create <type>and--list-typesversioninitandfirewalltrees (feat(init,firewall): add WireGuard mesh bootstrap and coold firewall client (alpha, v5) #72), pointing to--helpandllms-full.txtinstead of duplicating their large flag surfaceFixed:
--hostand-f, --force, which aren't global flags on the current build;--forcestays documented per-commanddatabase backup create: retention flag names (--retention-days-locally,--retention-max-storage-locally,--disable-local-backup, etc.)service env sync: removed the--previewflag it doesn't have--runtimeand--comment, noted the build-time/runtime defaultsprivate-key add: takes a plain file path, not@filenameuuid/name/batch:--forcehas no-fshorthand (onlydeploy canceldoes)Also added
app createandservice createexamples to the Examples section, adapted from the commands' own--helpexamples.llms.txt/llms-full.txt: regenerated withgo run ./coolify docs llms; no content changes, so they're not part of the diff.Every line in the diff traces back to captured
--helpoutput; no invented flags.