Skip to content

[cli-consistency] Verbose flag description mismatch between docs and source #14786

@github-actions

Description

@github-actions

Issue Description

Command: Global Options table
Location: docs/src/content/docs/setup/cli.md:117
Type: Flag description mismatch between documentation and source code
Priority: Medium

Current Documentation

Flag Description
-v, --verbose Enable verbose output with debugging details

Actual Source Code

// cmd/gh-aw/main.go:441
rootCmd.PersistentFlags().BoolVarP(&verboseFlag, "verbose", "v", false, 
    "Enable verbose output showing detailed information")

Issue

The documentation says the verbose flag enables output "with debugging details" but the actual flag description in the source code says "showing detailed information". These should match exactly.

Suggested Fix

Update the documentation to match the source code:

| `-v`, `--verbose` | Enable verbose output showing detailed information |

Why This Matters

  • Users running gh aw --help will see "showing detailed information"
  • The documentation should reflect what users actually see in the CLI
  • Consistent terminology helps users understand what the flag does
  • "Debugging details" implies lower-level information than "detailed information"

Alternative Solution

If "debugging details" is more accurate, update the source code instead. However, the source code wording seems more appropriate as --verbose is user-facing, while DEBUG=* is for debugging.

AI generated by CLI Consistency Checker

  • expires on Feb 12, 2026, 1:42 PM UTC

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