Skip to content

Fix CLI documentation: align parameter names with command signatures#7559

Merged
pelikhan merged 3 commits intomainfrom
copilot/fix-cli-documentation-inconsistency
Dec 24, 2025
Merged

Fix CLI documentation: align parameter names with command signatures#7559
pelikhan merged 3 commits intomainfrom
copilot/fix-cli-documentation-inconsistency

Conversation

Copy link
Contributor

Copilot AI commented Dec 24, 2025

Documentation used workflow-name as parameter placeholder while CLI commands use [workflow] or <workflow>, creating confusion about canonical names.

Changes:

  • Updated 15 CLI command examples across 4 documentation files
  • Primary updates in docs/src/content/docs/setup/cli.md: logs, run, enable, disable, mcp list, mcp inspect commands
  • Additional updates in guides for dispatchops, web-search, and examples
  • Preserved workflow-name in workflow path format examples (e.g., owner/repo/workflow-name) where it describes structure, not CLI parameters

Before:

gh aw logs workflow-name
gh aw run workflow-name --repo owner/repo
gh aw mcp inspect workflow-name

After:

gh aw logs workflow
gh aw run workflow --repo owner/repo
gh aw mcp inspect workflow

Documentation now matches --help output from actual CLI commands.

Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] Documentation shows "workflow-name" but CLI uses "workflow" in command signatures</issue_title>
<issue_description>## 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-nameworkflow 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-namegh aw logs workflow
  • Line 423: gh aw logs workflow-namegh aw logs workflow
  • Line 477: gh aw enable workflow-namegh aw enable workflow
  • Line 490: gh aw disable workflow-namegh aw disable workflow
  • Line 528: gh aw mcp list workflow-namegh aw mcp list workflow
  • Line 531: gh aw mcp inspect workflow-namegh aw mcp inspect workflow
  • And similar occurrences throughout the file

Status: Documentation needs alignment with CLI source code

AI generated by CLI Consistency Checker

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits December 24, 2025 22:05
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix documentation inconsistency between CLI and examples Fix CLI documentation: align parameter names with command signatures Dec 24, 2025
Copilot AI requested a review from mnkiefer December 24, 2025 22:11
@pelikhan pelikhan marked this pull request as ready for review December 24, 2025 22:15
@pelikhan pelikhan merged commit d346cdb into main Dec 24, 2025
4 checks passed
@pelikhan pelikhan deleted the copilot/fix-cli-documentation-inconsistency branch December 24, 2025 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

3 participants