Conversation
… description, project new whitespace Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR fixes 5 CLI help text consistency issues identified by automated inspection, addressing problems with outdated information, ambiguous descriptions, behavioral inconsistencies, and formatting irregularities.
Changes:
- Replaced the stale hardcoded codemod list in
fixhelp with a pointer to--list-codemods - Clarified
--repeatflag semantics in bothrun(main.go) andtrialcommands — the value is additional runs, so--repeat 3results in 4 total executions - Added the cancellation behavior note to the
disablecommand's long description to match its short description - Normalized indentation in
project newlong description from mixed tabs/spaces to consistent 2-space indentation
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
pkg/cli/fix_command.go |
Removes hardcoded (outdated) codemod list and replaces it with a --list-codemods pointer |
pkg/cli/trial_command.go |
Updates --repeat flag description and example comment to clarify "additional runs" semantics |
pkg/cli/project_command.go |
Normalizes indentation in "Project Setup:" block from tabs to 2-space indentation |
cmd/gh-aw/main.go |
Adds cancellation note to disable Long description; updates run --repeat flag description and example comment |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Short: "Disable agentic workflows and cancel any in-progress runs", | ||
| Long: `Disable one or more workflows by ID, or all workflows if no IDs are provided. | ||
|
|
||
| Any in-progress runs will be cancelled before disabling. |
There was a problem hiding this comment.
The "Any in-progress runs will be cancelled before disabling." line is immediately followed by the WorkflowIDExplanation block with no blank line separator. Comparing with the enableCmd Long description (which has a blank line before WorkflowIDExplanation), and other commands like fix, health, logs, and validate (all of which wrap WorkflowIDExplanation with blank lines on both sides), the disableCmd description is missing a blank line between the cancellation note and the workflow ID explanation. This inconsistency will cause the two sections to visually run together in the help output.
| Any in-progress runs will be cancelled before disabling. | |
| Any in-progress runs will be cancelled before disabling. |
Five CLI help text inconsistencies identified by automated inspection: outdated hardcoded codemod list in
fix, ambiguous--repeatsemantics inrun/trial, mismatch betweendisableshort/long descriptions, and mixed whitespace inproject new.Changes
fixcommand: Replaced stale hardcoded list of 8 codemods (out of ~25 registered) with a reference to--list-codemods, which dynamically reflects the actual registry--repeatflag (run+trial): Clarified that the value is additional runs, not total —--repeat 3executes 4 times (1 initial + 3 repeats). Updated both the flag description and the inline example comments which incorrectly said "Run 3 times total"disableLong description: Added cancellation note ("Any in-progress runs will be cancelled before disabling") to match the Short description, which already advertised this behaviorproject newLong description: Normalized indentation in the "Project Setup:" bullet list from mixed tabs/spaces to consistent spacesOriginal prompt
This section details on the original issue you should resolve
<issue_title>[cli-consistency] CLI Consistency Issues - 2026-03-02</issue_title>
<issue_description>### Summary
Automated CLI consistency inspection found 5 inconsistencies across command help text that should be addressed for better user experience and documentation clarity.
Breakdown by Severity
Inspection Details
--helprun for every command and subcommand)--helpflags, ran--list-codemods, and compared with documentation indocs/src/content/docs/setup/cli.mdFindings Summary
✅ No issues found in these areas:
-v,-h,--bannerpresent everywhere)github.github.comis the intentional docs domain perastro.config.mjs)mcp,pr,secrets,projectsubcommand structuresadd,compile,run,logs,audit,status,health,update,upgradecore commandsfixhelp has severely outdated hardcoded codemod list--repeatflag description is ambiguous inrunandtrialdisablesummary description and detailed help disagree on behaviorproject newhelp has mixed whitespace formattingDetailed Findings
1.
fix --help"Available codemods" section is severely outdatedCommands Affected:
fixPriority: High
Type: Outdated information
Current Output (from
./gh-aw fix --help):Issue: The flag name
repeatand phrase "Number of times to repeat" implies additional runs after the first (so--repeat 3= run once + 3 repeats = 4 total). However, the example--repeat 3 # Run 3 times totalindicates it means total count (3 total). The parenthetical(0 = run once)further suggests the default=0 maps to 1 total run, compounding the confusion for new users.Suggested Fix: Clarify the description to remove ambiguity: