-
Notifications
You must be signed in to change notification settings - Fork 43
Open
Labels
automationclicookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Issue Description
Priority: Medium
Type: Documentation inconsistency
Problem
The documentation organizes commands differently than how they appear in CLI help output, causing confusion about command organization.
Documentation Categories (cli.md)
From docs/src/content/docs/setup/cli.md:
- Getting Workflows: init, add, new, secrets
- Building: fix, compile
- Testing: trial, run
- Monitoring: list, status, logs, audit
- Agentic campaigns: campaign
- Management: enable, disable, remove, update, upgrade
- Advanced: mcp, pr transfer, mcp-server
- Utility Commands: version, completion, project
CLI Code Categories (main.go)
From cmd/gh-aw/main.go:372-393:
- Setup Commands: init, new, add, remove, update, upgrade, secrets
- Development Commands: compile, mcp, status, list, fix
- Execution Commands: run, enable, disable, trial
- Analysis Commands: logs, audit, health
- Utilities: mcp-server, pr, completion, hash, project
Discrepancies
- "secrets": Docs place under "Getting Workflows", code places under "Setup Commands" ✅ (code is more logical)
- "status/list": Docs place under "Monitoring", code places under "Development Commands" (inconsistent terminology)
- "fix": Docs place under "Building", code places under "Development Commands" ✅ (both reasonable)
- "mcp": Docs place under "Advanced", code places under "Development Commands" (inconsistent categorization)
- "health": Not documented but exists in code under "Analysis Commands"
Impact
- Users may not find commands where they expect based on documentation
- Inconsistent mental model between docs and CLI
Suggested Fix
Option 1 (Preferred): Update documentation to match CLI groups
- Reorganize sections in
cli.mdto match the 5 groups in main.go - This ensures
gh aw helpoutput matches documentation
Option 2: Update CLI to match documentation
- Reorganize command groups in main.go to match docs
- More invasive change, affects CLI help output
Recommended: Update documentation to match CLI (Option 1) since CLI structure is well-organized and changing it would affect user experience more significantly.
Missing from Documentation
The health command exists in the CLI but is not documented in cli.md:
// From cmd/gh-aw/main.go:554
healthCmd := cli.NewHealthCommand()
// ...
healthCmd.GroupID = "analysis"Should be added to documentation under Analysis Commands section.
Related to #12740
AI generated by CLI Consistency Checker
Metadata
Metadata
Assignees
Labels
automationclicookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!documentationImprovements or additions to documentationImprovements or additions to documentation