-
Notifications
You must be signed in to change notification settings - Fork 39
Description
Summary
Comprehensive CLI inspection completed on 2026-01-22. Found 4 consistency issues through source code analysis of command definitions, help text, and documentation cross-referencing.
Inspection Scope
Commands Analyzed: 23 total
- Main commands: add, audit, campaign, compile, completion, disable, enable, fix, init, list, logs, mcp, mcp-server, new, pr, remove, run, secrets, status, trial, update, upgrade, version
- MCP subcommands: add, inspect, list, list-tools
- PR subcommands: transfer
- Campaign subcommands: (list), status, new, validate
- Secrets subcommands: set, bootstrap
- Completion subcommands: install, uninstall, bash, zsh, fish, powershell
Breakdown by Severity
- High: 0 (no functionality-breaking issues)
- Medium: 2 (documentation gaps affecting discoverability)
- Low: 2 (minor documentation inconsistencies)
Issues Found
See linked sub-issues for details on each finding:
- #aw_a1b2c3d4e5f6_1 - Missing
upgradecommand in main CLI documentation - #aw_a1b2c3d4e5f6_2 - Missing
completioncommand in main CLI commands section - #aw_a1b2c3d4e5f6_3 -
enablecommand not listed separately fromdisable - #aw_a1b2c3d4e5f6_4 - Missing
campaigncommand details in documentation
What Went Well
✅ No trailing punctuation issues - All Short descriptions follow CLI conventions
✅ Consistent command naming - All commands use proper kebab-case (e.g., mcp-server)
✅ Good flag documentation - Flags are well-documented with examples
✅ No typos detected - Spelling is consistent (Markdown, GitHub, YAML, MCP)
✅ Example quality - Commands have clear, practical examples
Methodology
Due to environment constraints (no Go compiler available), performed source code analysis instead of running actual CLI:
- Extracted command definitions from
cmd/gh-aw/main.goandpkg/cli/*.go - Compared with documentation in
docs/src/content/docs/setup/cli.md - Validated consistency using test expectations from
*_test.gofiles - Cross-referenced command Use, Short, and Long descriptions
Next Steps
- Update main CLI documentation to include missing commands
- Consider adding a table of all commands with their subcommands for easy reference
- Verify all documented examples match actual command behavior (requires running CLI)
AI generated by CLI Consistency Checker