-
Notifications
You must be signed in to change notification settings - Fork 49
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
Priority: Medium
Type: Documentation gap
Problem
The list command documentation in cli.md provides only 4 examples, while the status command (which is very similar) provides 6 examples. The list command is missing examples for common use cases.
Current Examples for 'list' (cli.md:353-358)
gh aw list # List all workflows
gh aw list ci- # Filter by pattern (case-insensitive)
gh aw list --json # Output in JSON format
gh aw list --label automation # Filter by labelCurrent Examples for 'status' (cli.md:369-374)
gh aw status # All workflows
gh aw status --ref main # With run info for main branch
gh aw status --label automation # Filter by label
gh aw status --repo owner/other-repo # Check different repositoryMissing Examples for 'list'
The list command does NOT support --repo flag (verified in source code), but could benefit from:
- Pattern filtering example with more context
- Combining multiple flags
- Use case explanation
Suggested Fix
Add more examples to the list command documentation in cli.md:
gh aw list # List all workflows
gh aw list ci- # Filter by pattern (case-insensitive)
gh aw list --json # Output in JSON format
gh aw list --label automation # Filter by label
gh aw list ci- --json # Combine pattern and JSON output
gh aw list --label bug --label test # Filter by multiple labels (if supported)Also clarify in the description that list is faster than status because it doesn't query GitHub API for workflow state.
Related Code
- Documentation:
docs/src/content/docs/setup/cli.md:346-363 - Implementation:
pkg/cli/list_workflows_command.go:30-64 - Source code confirms
listdoes NOT have--repoflag (unlikestatus)
Related to [cli-consistency] CLI Consistency Issues - January 30, 2026 #12740
AI generated by CLI Consistency Checker
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