-
Notifications
You must be signed in to change notification settings - Fork 226
Closed as not planned
Closed as not planned
Copy link
Labels
automationclicookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!documentationImprovements or additions to documentationImprovements or additions to documentation
Description
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 --helpwill 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
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
automationclicookieIssue Monster Loves Cookies!Issue Monster Loves Cookies!documentationImprovements or additions to documentationImprovements or additions to documentation