docs: comprehensive CLI help text for all commands#5
Merged
Conversation
… gaps - Add detailed Long descriptions with phases, examples, and flag explanations for all 12 commands and their subcommands (setup, create, doctor, update, build, publish, dag, fwversion, config, upgrade, run, version) - Add root command overview listing all available commands with descriptions - Add missing flywork run section to README with flags table - Fix README config table: parent_version default 26.01.01, add branch key - Fix README repo count from 34 to 38 to match actual DAG - Add flags tables for setup, create, update, build, publish, upgrade in README - Add global flags section documenting -v/--verbose and -h/--help - Add run.go and internal/runner to project structure in README
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
1 participant
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.
Summary
Longdescriptions with phases, examples, and flag explanations for all 12 CLI commands and their subcommands (setup,create,doctor,update,build,publish,dag show/layers/affected/export,fwversion show/bump/check/families,config get/set/reset,upgrade,run,version)flywork runsection to README with full documentation and flags tableparent_versiondefault corrected from1.0.0-SNAPSHOTto26.01.01, added missingbranchkeysetup,create,update,build,publish, andupgradein README-v/--verboseand-h/--helprun.goandinternal/runnerto project structure in READMETest plan
go build ./...passesgo vet ./...passesgo test ./...passes