Skip to content

[cli-consistency] CLI Consistency Issues - 2026-10-02 #65025

Description

@github-actions

Summary

Inspected 44 top-level commands from /tmp/gh-aw/agent/all-help.txt and per-command help files. Found 2 issues (severity: 0 high, 0 medium, 2 low).

Documentation gaps

1. compile --require-self-hosted-runners is missing from the CLI docs (low)

  • Help output: --require-self-hosted-runners Fail compilation unless every generated workflow job selects a self-hosted runner
  • Expected: flag documented in docs/src/content/docs/setup/cli.md (every other compile flag is).
  • Actual: no mention of the flag in the doc.
  • Suggested fix: add it to the compile section of cli.md.

Flag consistency

2. doctor --repo description differs from all other commands (low)

  • doctor: -r, --repo string Target repository (owner/repo format only; GHES host prefixes are not supported)
  • Most other commands: -r, --repo string Target repository ([HOST/]owner/repo format). Defaults to current repository
  • Expected: consistent wording, or an explicit note in the docs on why doctor lacks [HOST/] support.
  • Suggested fix: align wording or document the GHES limitation in cli.md.

Inspection metadata

  • Commands inspected: all top-level commands listed in gh aw --help (44) plus help variants
  • Date: 2026-10-02
  • Method: scripted comparison of help flags against cli.md, flag-description consistency checks across commands, typo scan. No typos found.

Generated by ✅ CLI Consistency Checker · copilot · auto · 24.6 AIC · ⌖ 5.49 AIC · ⊞ 8.3K · ◷

  • expires on Oct 4, 2026, 5:31 AM UTC-08:00

Activity

  1. github-actions commented on Oct 4, 2026

    @github-actions
    ContributorAuthor

    This issue was automatically closed because it expired on 2026-10-04T13:31:25.243Z.

    Closed by Workflow

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