Open
fix: correct --yes verb, --dir env hint, and add-wizard docs across 9 commands#44050
Conversation
…add-wizard docs - Fix --yes flag: update_command uses 'update', upgrade_command uses 'upgrade' - Fix --dir flag: add $GH_AW_WORKFLOWS_DIR to descriptions in compile, remove (main.go), validate, fix, add, add-wizard, deploy, update, upgrade commands - Update add-wizard docs to include --append and --no-security-scanner options" Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix CLI consistency issues identified in inspection
fix: correct --yes verb, --dir env hint, and add-wizard docs across 9 commands
Jul 7, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves gh aw CLI consistency by aligning help text and docs with existing behavior, especially around workflow directory overrides and org-mode confirmation flags.
Changes:
- Fixed
--yes/-yhelp text verbs forupdateandupgradeto match what the commands actually do. - Updated
--dir/-dhelp text across commands to include the$GH_AW_WORKFLOWS_DIRenvironment variable hint. - Updated
add-wizarddocs to include--appendand--no-security-scannerin the documented options list.
Show a summary per file
| File | Description |
|---|---|
| pkg/cli/validate_command.go | Updates --dir help text to mention $GH_AW_WORKFLOWS_DIR. |
| pkg/cli/upgrade_command.go | Updates --dir help text and fixes --yes help verb to “upgrade confirmations”. |
| pkg/cli/update_command.go | Updates --dir help text and fixes --yes help verb to “update confirmations”. |
| pkg/cli/fix_command.go | Updates --dir help text to mention $GH_AW_WORKFLOWS_DIR. |
| pkg/cli/deploy_command.go | Updates --dir help text to mention $GH_AW_WORKFLOWS_DIR. |
| pkg/cli/add_wizard_command.go | Updates --dir help text to mention $GH_AW_WORKFLOWS_DIR. |
| pkg/cli/add_command.go | Updates --dir help text to mention $GH_AW_WORKFLOWS_DIR. |
| cmd/gh-aw/main.go | Updates compile/remove --dir help text to mention $GH_AW_WORKFLOWS_DIR. |
| docs/src/content/docs/setup/cli.md | Adds --append and --no-security-scanner to the add-wizard options list. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 9/9 changed files
- Comments generated: 1
- Review effort level: Low
Comment on lines
160
to
162
| cmd.Flags().Bool("create-issue", false, "Open a GitHub issue in each org repository with agentic workflows (requires --org)") | ||
| cmd.Flags().BoolP("yes", "y", false, "Auto-accept org-mode create confirmations (required in CI)") | ||
| cmd.Flags().BoolP("yes", "y", false, "Auto-accept org-mode upgrade confirmations (required in CI)") | ||
| cmd.Flags().Bool("audit", false, "Check dependency health without performing upgrades") |
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.
Three CLI consistency issues found by automated inspection: wrong verb in
--yesflag descriptions forupdate/upgrade,$GH_AW_WORKFLOWS_DIRsilently omitted from--dirhelp text in 9 commands, and two flags missing from theadd-wizarddocs section.Changes
--yesflag verb mismatch (update_command.go,upgrade_command.go)Both commands copied the
deploydescription verbatim and said"create confirmations".update: →"Auto-accept org-mode update confirmations"upgrade: →"Auto-accept org-mode upgrade confirmations"--dirflag missing env var hint (9 commands)GetWorkflowDir()reads$GH_AW_WORKFLOWS_DIRfor all commands, but onlylintandlistsurfaced this in help text. Updated the remaining 9 to match:Affected:
compile,remove(cmd/gh-aw/main.go),validate,fix,add,add-wizard,deploy,update,upgrade.add-wizarddocs missing two flags (docs/src/content/docs/setup/cli.md)--appendand--no-security-scannerexist in the CLI but were absent from the Options table. Added both to match theaddcommand's documented options.