[cli-consistency] Documentation shows "workflow-name" but CLI uses "workflow" in command signatures

[github-actions]

Issue Description

Commands: Multiple commands
Type: Documentation inconsistency
Priority: Medium

Issue

The CLI documentation at docs/src/content/docs/setup/cli.md frequently uses the parameter name workflow-name in examples, but the actual CLI command definitions in the source code use [workflow] or (workflow) as the parameter placeholder.

Examples

Documentation (line 416-422):

#### `logs`

Download and analyze workflow execution logs...

```bash wrap
gh aw logs                                 # Download logs for all workflows
gh aw logs workflow-name                   # Download logs for specific workflow
gh aw logs -c 10 --start-date -1w         # Filter by count and date

CLI Source Code (pkg/cli/logs_command.go line 26):

Use:   "logs [workflow]",

Documentation (line 476-478):

gh aw enable                                # Enable all workflows
gh aw enable workflow-name                  # Enable specific workflow

CLI Source Code (cmd/gh-aw/main.go line 133):

Use:   "enable [workflow]...",

Impact

This creates confusion about:

1. Whether the parameter should include hyphens or not
2. What the canonical parameter name actually is
3. Consistency between what --help shows and what documentation shows

Suggested Fix

Option 1 (Recommended): Update documentation to match CLI source code

• Change all workflow-name → workflow in examples
• This aligns with the actual CLI help output

Option 2: Update CLI source code to match documentation

• Change [workflow] → [workflow-name] in Use strings
• More descriptive but longer

Recommendation: Go with Option 1 for consistency with actual CLI behavior and brevity.

Files to Update

docs/src/content/docs/setup/cli.md:

• Line 420: gh aw logs workflow-name → gh aw logs workflow
• Line 423: gh aw logs workflow-name → gh aw logs workflow
• Line 477: gh aw enable workflow-name → gh aw enable workflow
• Line 490: gh aw disable workflow-name → gh aw disable workflow
• Line 528: gh aw mcp list workflow-name → gh aw mcp list workflow
• Line 531: gh aw mcp inspect workflow-name → gh aw mcp inspect workflow
• And similar occurrences throughout the file

Status: Documentation needs alignment with CLI source code

AI generated by CLI Consistency Checker