Skip to content

[plan] Review and document existing CLI commands #8492

@github-actions

Description

@github-actions

Overview

This tracking issue covers a comprehensive review of all existing CLI commands in gh-aw to ensure they are well-documented, consistent, and follow best practices.

Source: Discussion #8482

Context

The gh-aw CLI has grown to include 16+ command files in pkg/cli/ covering setup, development, execution, and analysis workflows. A systematic review will ensure:

  • Command consistency (naming, flags, behavior)
  • Comprehensive documentation
  • Proper error handling and validation
  • Test coverage
  • User experience alignment

Discovered Commands

Based on analysis of cmd/gh-aw/main.go and pkg/cli/:

Setup Commands: init, new, add, remove, update, secrets
Development Commands: compile, mcp, status, mcp-server, fix
Execution Commands: run, enable, disable, trial
Analysis Commands: logs, audit, campaign
Utilities: pr, version

Planned Sub-Issues

  1. Audit command documentation and help text - Review all command help text for clarity and completeness
  2. Review command flag consistency - Ensure flags follow consistent naming patterns across commands
  3. Validate command test coverage - Identify commands missing tests and add coverage
  4. Review command grouping and organization - Ensure logical grouping in help output
  5. Document command patterns and conventions - Create developer guide for adding new commands

Success Criteria

  • All commands have comprehensive help text
  • Flag naming is consistent across commands
  • All commands have test coverage
  • Command grouping is logical and user-friendly
  • Developer documentation exists for command patterns

AI generated by Plan Command for discussion #8482

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions