Skip to content

[cli-consistency] Inconsistent command categorization between docs and CLI help #12745

@github-actions

Description

@github-actions

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:

  1. Getting Workflows: init, add, new, secrets
  2. Building: fix, compile
  3. Testing: trial, run
  4. Monitoring: list, status, logs, audit
  5. Agentic campaigns: campaign
  6. Management: enable, disable, remove, update, upgrade
  7. Advanced: mcp, pr transfer, mcp-server
  8. Utility Commands: version, completion, project

CLI Code Categories (main.go)

From cmd/gh-aw/main.go:372-393:

  1. Setup Commands: init, new, add, remove, update, upgrade, secrets
  2. Development Commands: compile, mcp, status, list, fix
  3. Execution Commands: run, enable, disable, trial
  4. Analysis Commands: logs, audit, health
  5. Utilities: mcp-server, pr, completion, hash, project

Discrepancies

  1. "secrets": Docs place under "Getting Workflows", code places under "Setup Commands" ✅ (code is more logical)
  2. "status/list": Docs place under "Monitoring", code places under "Development Commands" (inconsistent terminology)
  3. "fix": Docs place under "Building", code places under "Development Commands" ✅ (both reasonable)
  4. "mcp": Docs place under "Advanced", code places under "Development Commands" (inconsistent categorization)
  5. "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.md to match the 5 groups in main.go
  • This ensures gh aw help output 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

No one assigned

    Labels

    automationclicookieIssue Monster Loves Cookies!documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions