Skip to content

[cli-consistency] CLI Consistency Issues - January 2026 #11286

@github-actions

Description

@github-actions

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:

  1. #aw_a1b2c3d4e5f6_1 - Missing upgrade command in main CLI documentation
  2. #aw_a1b2c3d4e5f6_2 - Missing completion command in main CLI commands section
  3. #aw_a1b2c3d4e5f6_3 - enable command not listed separately from disable
  4. #aw_a1b2c3d4e5f6_4 - Missing campaign command 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.go and pkg/cli/*.go
  • Compared with documentation in docs/src/content/docs/setup/cli.md
  • Validated consistency using test expectations from *_test.go files
  • Cross-referenced command Use, Short, and Long descriptions

Next Steps

  1. Update main CLI documentation to include missing commands
  2. Consider adding a table of all commands with their subcommands for easy reference
  3. Verify all documented examples match actual command behavior (requires running CLI)

AI generated by CLI Consistency Checker

Sub-issues

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