Skip to content

[cli-consistency] Missing examples in 'list' command documentation #12742

@github-actions

Description

@github-actions

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 label

Current 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 repository

Missing Examples for 'list'

The list command does NOT support --repo flag (verified in source code), but could benefit from:

  1. Pattern filtering example with more context
  2. Combining multiple flags
  3. 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

AI generated by CLI Consistency Checker

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