Skip to content

[cli-consistency] CLI Consistency Issues - 2026-09-30 #64510

New issue
New issue
Closed as not planned
#65448
Closed as not planned
[cli-consistency] CLI Consistency Issues - 2026-09-30#64510
#65448
Labels
automationclicookieIssue Monster Loves Cookies!documentationImprovements or additions to documentation

Description

@github-actions
github-actions
bot
opened on Sep 30, 2026

Summary

Inspected ~45 top-level commands (plus subcommands) from /tmp/gh-aw/agent/all-help.txt and per-command help files, and compared them with docs/src/content/docs/setup/cli.md. All top-level commands are documented. Found 3 issues: 0 high, 1 medium, 2 low.

Documentation gaps

1. (medium) gh aw compile --require-self-hosted-runners missing from cli.md

  • Help: --require-self-hosted-runners Fail compilation unless every generated workflow job selects a self-hosted runner
  • Actual: the flag is documented only in reference/self-hosted-runners.md and reference/compiler-enterprise-environment-controls.md. It does not appear in the compile Options list in setup/cli.md.
  • Suggested fix: add the flag to the compile Options list with a one-line description.

Inconsistencies

2. (low) --artifacts default is described differently for logs and audit, and the audit docs conflict

  • logs: Artifact sets to download (default: usage — compact workflow metadata and usage data)... (default [usage])
  • audit: Artifact sets to download (default: all — comprehensive artifacts required for analysis)
  • cli.md line 601 says default: all. The audit help does not show Cobra's (default [...]) suffix, unlike logs.
  • Suggested fix: keep the wording consistent, and make the audit help show the actual default value.

3. (low) --repo help text differs in doctor

  • Most commands: Target repository ([HOST/]owner/repo format). Defaults to current repository
  • doctor: Target repository (owner/repo format only; GHES host prefixes are not supported)
  • Also: add-wizard uses "Copilot, Claude, Codex, Gemini, or Pi", while the flags use lowercase (copilot, claude, codex, gemini, pi). This one is cosmetic.
  • Suggested fix: confirm the doctor limitation is intentional and mention it in cli.md. Otherwise align the text with the other commands.

Inspection metadata

  • Date: 2026-09-30
  • Method: manual and scripted scan of the pre-collected help output. Checked flag short/long pairings (-r, -j, -d, -e, -o, -f, -y), typos, and docs coverage of commands and flags.
  • Run: 36721455184

Generated by ✅ CLI Consistency Checker · copilot · auto · 26.3 AIC · ⌖ 7.73 AIC · ⊞ 8.3K · ◷

  • expires on Oct 2, 2026, 5:33 AM UTC-08:00

Activity

  1. github-actions
    added
    documentationImprovements or additions to documentation
    automation
    cli
    cookieIssue Monster Loves Cookies!
    on Sep 30, 2026

  2. github-actions commented on Oct 1, 2026

    @github-actions
    github-actionsBot
    on Oct 1, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I have identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 8.08 AIC · ⌖ 12.4 AIC · ⊞ 14.1K · ◷

  3. github-actions commented on Oct 1, 2026

    @github-actions
    github-actionsBot
    on Oct 1, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I’ve identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 6.27 AIC · ⌖ 16.4 AIC · ⊞ 14.1K · ◷

  4. github-actions commented on Oct 1, 2026

    @github-actions
    github-actionsBot
    on Oct 1, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I've identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 8.77 AIC · ⌖ 10.5 AIC · ⊞ 14.1K · ◷

  5. github-actions commented on Oct 1, 2026

    @github-actions
    github-actionsBot
    on Oct 1, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    Ive identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 6.11 AIC · ⌖ 11.2 AIC · ⊞ 14.1K · ◷

  6. github-actions commented on Oct 1, 2026

    @github-actions
    github-actionsBot
    on Oct 1, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I've identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 6.87 AIC · ⌖ 10.5 AIC · ⊞ 14.1K · ◷

  7. github-actions commented on Oct 1, 2026

    @github-actions
    github-actionsBot
    on Oct 1, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    Ive identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 6.74 AIC · ⌖ 10.8 AIC · ⊞ 14K · ◷

  8. github-actions commented on Oct 1, 2026

    @github-actions
    github-actionsBot
    on Oct 1, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I've identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 6.33 AIC · ⌖ 12 AIC · ⊞ 14K · ◷

  9. github-actions commented on Oct 1, 2026

    @github-actions
    github-actionsBot
    on Oct 1, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I have identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 8.83 AIC · ⌖ 12.9 AIC · ⊞ 14K · ◷

  10. github-actions commented on Oct 1, 2026

    @github-actions
    github-actionsBot
    on Oct 1, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I've identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 6.71 AIC · ⌖ 14.6 AIC · ⊞ 14K · ◷

  11. github-actions commented on Oct 1, 2026

    @github-actions
    github-actionsBot
    on Oct 1, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 6.46 AIC · ⌖ 10.3 AIC · ⊞ 14K · ◷

  12. github-actions commented on Oct 1, 2026

    @github-actions
    github-actionsBot
    on Oct 1, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I've identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 7.81 AIC · ⌖ 9.33 AIC · ⊞ 14K · ◷

  13. github-actions commented on Oct 1, 2026

    @github-actions
    github-actionsBot
    on Oct 1, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    Ive identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 8.88 AIC · ⌖ 10.6 AIC · ⊞ 14K · ◷

  14. github-actions commented on Oct 2, 2026

    @github-actions
    github-actionsBot
    on Oct 2, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I've identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 7.43 AIC · ⌖ 10.4 AIC · ⊞ 14.1K · ◷

  15. github-actions commented on Oct 2, 2026

    @github-actions
    github-actionsBot
    on Oct 2, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 7.06 AIC · ⌖ 9.2 AIC · ⊞ 14.1K · ◷

  16. github-actions commented on Oct 2, 2026

    @github-actions
    github-actionsBot
    on Oct 2, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I've identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 6.46 AIC · ⌖ 10.3 AIC · ⊞ 14.1K · ◷

  17. github-actions commented on Oct 2, 2026

    @github-actions
    github-actionsBot
    on Oct 2, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I've identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 6.48 AIC · ⌖ 12.2 AIC · ⊞ 14.1K · ◷

  18. github-actions commented on Oct 2, 2026

    @github-actions
    github-actionsBot
    on Oct 2, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I've identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 7.6 AIC · ⌖ 10.4 AIC · ⊞ 14K · ◷

  19. github-actions commented on Oct 2, 2026

    @github-actions
    github-actionsBot
    on Oct 2, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I've identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 5.73 AIC · ⌖ 10.3 AIC · ⊞ 14K · ◷

  20. github-actions commented on Oct 2, 2026

    @github-actions
    github-actionsBot
    on Oct 2, 2026 – with GitHub Actions
    ContributorAuthor

    🍪 Issue Monster selected this for Copilot

    I've identified this issue as a good candidate for automated resolution and requested assignment to the Copilot coding agent.

    If assignment succeeds, the Copilot coding agent will analyze the issue and create a pull request with the fix.

    Om nom nom! 🍪

    🍪 Om nom nom by Issue Monster · pi · gpt54 · 8.29 AIC · ⌖ 10.3 AIC · ⊞ 14.1K · ◷

  21. github-actions commented on Oct 2, 2026

    @github-actions
    github-actionsBot
    on Oct 2, 2026 – with GitHub Actions
    ContributorAuthor

    This issue was automatically closed because it expired on 2026-10-02T13:33:40.418Z.

    Closed by Workflow

  22. github-actions
    closed this as not plannedon Oct 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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