fix: resolve 16 CLI consistency issues from 2026-07-22 inspection#47337
Conversation
- A-1: Update engine lists (add-wizard, completion) from 4 to 7 engines - A-3: Fix inconsistent verb form in fix command (Write → Writes) - A-4: Remove scare-quotes around 'simulated' in trial command - A-6: Fix inconsistent casing in init flags (Agentic Workflows → agentic-workflows) - A-7: Standardize --artifacts default description style (audit.go) - A-8: Fix mixed noun/verb list in deploy command Long description - A-9: Fix dangling participle in mcp-server command Long description - B-2: Fix misleading --no-release-bump flag description - B-4: Clarify compile --force only applies when --dependabot is set - B-5: Add note that deploy always creates a PR - C-2: Update secrets bootstrap --engine list to all 7 engines in docs - C-3: Add health --days valid values (7, 30, 90) to docs - C-8: Add --evals to audit options list in docs - D-4: Fix bare numeric ID audit example to include --repo - D-5: Improve --cache-before example comments in docs - D-7: Improve init --engine claude example comment Closes #47332 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Clarifies CLI help and documentation for engines, flags, examples, and command behavior.
Changes:
- Completes supported-engine lists.
- Corrects misleading flag and command descriptions.
- Aligns CLI examples and reference documentation.
Show a summary per file
| File | Description |
|---|---|
pkg/cli/update_command.go |
Clarifies release-bump flags. |
pkg/cli/trial_command.go |
Improves description wording. |
pkg/cli/mcp_server_command.go |
Clarifies subprocess behavior. |
pkg/cli/init_command.go |
Corrects artifact naming and example. |
pkg/cli/fix_command.go |
Fixes grammatical consistency. |
pkg/cli/deploy_command.go |
Clarifies deployment and mandatory PR creation. |
pkg/cli/completion_command.go |
Lists all supported engines. |
pkg/cli/audit.go |
Corrects example and artifact description. |
pkg/cli/add_wizard_command.go |
Lists all engines; existing test needs updating. |
docs/src/content/docs/setup/cli.md |
Updates engine, cache, audit, and health documentation. |
cmd/gh-aw/main.go |
Clarifies compile --force scope. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 11/11 changed files
- Comments generated: 1
- Review effort level: Medium
| This command walks you through: | ||
| - Selecting an AI engine (Copilot, Claude, Codex, or Gemini) | ||
| - Selecting an AI engine (Copilot, Claude, Codex, Gemini, Antigravity, OpenCode, or Pi) |
|
🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅ |
|
✅ Design Decision Gate 🏗️ completed the design decision gate check. No ADR enforcement needed: PR #47337 does not have the 'implementation' label and has only 13 new lines of code in business logic directories (threshold: 100). |
|
✅ Test Quality Sentinel completed test quality analysis. No test files were added or modified in this PR. This PR (#47337) contains only CLI consistency fixes to 11 non-test files. Test Quality Sentinel analysis skipped. |
|
✅ PR Code Quality Reviewer completed the code quality review. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Skills-Based Review 🧠
Applied /codebase-design and /diagnosing-bugs — requesting changes on two issues.
📋 Key Themes & Highlights
Issues Found
-
Broken test (
pkg/cli/add_wizard_command_test.go) — the engine list inadd_wizard_command.gowas expanded but the test still asserts the old 4-engine substring"Copilot, Claude, Codex, or Gemini". This will causeTestAddWizardCommandMentionsEnginesto fail. (Already flagged in an existing review comment.) -
Inconsistent
--cache-beforeexample comment (docs/src/content/docs/setup/cli.md, line 484) — three of the four examples were updated to use "Evict local cache..." but the fourth still says "Clean up, then download...". Minor but undermines the consistency goal of this PR.
Positive Highlights
- ✅
--forceflag clarification correctly scopes the flag to--dependabotonly - ✅
--no-release-bumpreword is accurate and removes the misleading "disable all" implication - ✅ em-dash style change in
--artifactsdescription is consistent with thelogsflag pattern - ✅
deployLong description now uses parallel verb-phrase form throughout - ✅
mcp-serverdangling participle fix reads cleanly
🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · sonnet46 18.9 AIC · ⌖ 4.68 AIC · ⊞ 6.7K
Comment /matt to run again
| gh aw logs --cache-before -30d # Clean folders older than 30 days | ||
| gh aw logs --cache-before 2024-01-01 # Clean folders from before a specific date | ||
| gh aw logs --cache-before -1w # Evict local cache older than 1 week, then proceed with normal run download | ||
| gh aw logs --cache-before -30d # Evict local cache entries older than 30 days |
There was a problem hiding this comment.
[/codebase-design] Inconsistent comment in the fourth --cache-before example: still says "Clean up" while the three examples above it were updated to "Evict local cache".
💡 Suggested fix
Change:
gh aw logs my-workflow --cache-before -1mo -c 20 # Clean up, then download 20 runs of a specific workflow
To:
gh aw logs my-workflow --cache-before -1mo -c 20 # Evict local cache older than 1 month, then download 20 runs of a specific workflow
All four examples in this block should use the same vocabulary for cache eviction.
@copilot please address this.
There was a problem hiding this comment.
Review: CLI Consistency Fixes
The changes are mostly well-targeted and accurate. Two issues to address:
Existing comment (already flagged): pkg/cli/add_wizard_command.go line 22 — expanding the engine list breaks TestAddWizardCommandMentionsEngines which still expects the old 4-engine substring. The test must be updated to match the new list.
New finding: docs/src/content/docs/setup/cli.md line 483 — the 4th --cache-before example comment (# Clean up, then download 20 runs...) was not updated to the "Evict local cache" phrasing applied to the other three examples in the same block. See inline comment.
🧵 Reviewed using Impeccable skills by Impeccable Skills Reviewer · sonnet46 28 AIC · ⌖ 5.67 AIC · ⊞ 5K
| gh aw logs --cache-before -1w # Clean folders older than 1 week, then download latest runs | ||
| gh aw logs --cache-before -30d # Clean folders older than 30 days | ||
| gh aw logs --cache-before 2024-01-01 # Clean folders from before a specific date | ||
| gh aw logs --cache-before -1w # Evict local cache older than 1 week, then proceed with normal run download |
There was a problem hiding this comment.
The 4th --cache-before example comment was not updated to match the new "Evict local cache" phrasing used in the three comments above it:
gh aw logs my-workflow --cache-before -1mo -c 20 # Clean up, then download 20 runs of a specific workflow
Should be consistent, e.g.:
gh aw logs my-workflow --cache-before -1mo -c 20 # Evict local cache, then download 20 runs of a specific workflow
@copilot please address this.
There was a problem hiding this comment.
Broken test must be fixed before merge.
The existing comment on pkg/cli/add_wizard_command.go:22 already identifies the root cause: pkg/cli/add_wizard_command_test.go:15 asserts the exact string "Copilot, Claude, Codex, or Gemini", which no longer exists in the Long help text after this change. This will fail CI.
💡 Details
The test at add_wizard_command_test.go:15 needs to be updated to match the new engine list string "Copilot, Claude, Codex, Gemini, Antigravity, OpenCode, or Pi", or refactored to check for individual engine names rather than an exact conjunction string.
All other changes (doc clarifications, flag description rewording, grammar fixes) look accurate and are improvements over the previous text. The --no-release-bump description reword is more precise than the original, which contradicted itself by saying "disable all" while parenthetically noting core actions are still updated.
🔎 Code quality review by PR Code Quality Reviewer · sonnet46 30.2 AIC · ⌖ 4.54 AIC · ⊞ 5.7K
Comment /review to run again
|
@copilot run pr-finisher skill |
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Fixed in b2f8dfb.
I also validated locally with |
|
🎉 This pull request is included in a new release. Release: |
Addresses 16 of the 30 issues surfaced by the automated CLI Consistency Checker (run 29925018585), covering engine list gaps, misleading flag descriptions, style inconsistencies, and doc/help mismatches.
Engine list completeness (A-1, C-2)
add-wizard,completion, and the docssecrets bootstrapsection listed only 4 engines; updated all three to include all 7:copilot, claude, codex, gemini, antigravity, opencode, pi.Flag description accuracy (B-2, B-4, B-5)
--no-release-bump: reworded from "Disable automatic major version bumps for all actions (only core actions/* are force-updated)" → "Restrict automatic major version bumps to core actions/* only (non-core actions are left as-is)" — previous wording implied a complete disable.compile --force: clarified it only applies when--dependabotis set.deploy: added explicit note that PR creation is mandatory ("the--create-pull-requestflag is not needed").Grammar and style (A-3, A-4, A-6, A-7, A-8, A-9)
fixcommand: "Write updated files" → "Writes updated files" (consistent third-person verb form).trialcommand: removed scare-quotes from"simulated".init --no-agent: "Agentic Workflows" → "agentic-workflows" to match--no-skilland the actual artifact path.audit --artifactsdefault parenthetical: switched from comma-separated phrase to em-dash style matchinglogs.deployLong description: replaced mixed noun/verb list with a consistent verb-phrase form.mcp-serverLong description: split dangling participial clause into a separate sentence.Example correctness (D-4, D-5, D-7)
auditfirst example: bare numeric ID now shows--repo owner/repo(required without a full URL).logs --cache-beforedocs examples: replaced "Clean folders…" with "Evict local cache…" to avoid implying download filtering.init --engine claudeexample comment: "Skip Copilot-specific artifacts" → "Use Claude engine — skips Copilot MCP/skill files".Docs additions (C-3, C-8)
health: added "The--daysflag accepts 7, 30, or 90 (default: 7)." (parallel to existingforecastnote).auditoptions list: added missing--evals.