Skip to content

Align CLI help text semantics and terminology across mcp, project, pr, completion, logs, and init#30696

Merged
pelikhan merged 2 commits into
mainfrom
copilot/cli-consistency-fixes
May 6, 2026
Merged

Align CLI help text semantics and terminology across mcp, project, pr, completion, logs, and init#30696
pelikhan merged 2 commits into
mainfrom
copilot/cli-consistency-fixes

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 6, 2026

CLI consistency inspection flagged six documentation-level inconsistencies in command help output: missing no-arg behavior, misleading parent command wording, casing mismatch, ambiguous cache-maintenance examples, and minor grammar drift. This change set normalizes those surfaces so help text matches actual command behavior.

  • mcp inspect: document no-arg behavior

    • Added explicit long-help text that gh aw mcp inspect (without args) lists workflows with MCP server configuration.
  • Parent command wording: project and pr

    • project parent command description now reflects creation-focused behavior (project new) rather than generic “manage” wording.
    • pr parent command long description now uses singular phrasing (“provides a tool”) to match the single transfer subcommand.
  • Shell name casing consistency

    • Standardized completion long help shell list to use PowerShell casing.
  • logs --after example intent clarification

    • Updated cache-maintenance example comments to describe actual semantics: evict local cache before downloading runs (not delete-only behavior).
  • init --codespaces grammar cleanup

    • Refined flag help text to include missing articles: “with an empty value for the current repo only”.
  • Focused test updates

    • Updated/added assertions in existing CLI command tests to pin these help-text contracts and prevent regression.
Before:
  gh aw logs --after -1w  # Delete cached run folders older than 1 week

After:
  gh aw logs --after -1w  # Evict local cache older than 1 week before downloading runs

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • https://api.github.com/graphql
    • Triggering command: /usr/bin/gh gh repo view --json owner,name --jq .owner.login + "/" + .name k ./../.prettieriggit util (http block)
    • Triggering command: /usr/bin/gh /usr/bin/gh api graphql -f query=query($owner: String!, $name: String!) { repository(owner: $owner, name: $name) { hasDiscussionsEnabled } } -f owner=github -f name=gh-aw (http block)
    • Triggering command: /usr/bin/gh /usr/bin/gh api graphql -f query=query($owner: String!, $name: String!) { repository(owner: $owner, name: $name) { hasDiscussionsEnabled } } -f owner=github -f name=gh-aw er_test (http block)
  • https://api.github.com/orgs/test-owner/actions/secrets
    • Triggering command: /usr/bin/gh gh api /orgs/test-owner/actions/secrets --jq .secrets[].name on' --ignore-path ../../../.pret.prettierignore (http block)
    • Triggering command: /usr/bin/gh gh api /orgs/test-owner/actions/secrets --jq .secrets[].name /ref/tags/v9 git ode_modules/.bininternal/tools/generate-action-metadata/main.go --show-toplevel git /usr/bin/git git rev-�� w/js/**/*.json' --ignore-path git 64/bin/go --show-toplevel git (http block)
  • https://api.github.com/repos/actions/ai-inference/git/ref/tags/v1
    • Triggering command: /usr/bin/gh gh api /repos/actions/ai-inference/git/ref/tags/v1 --jq [.object.sha, .object.type] | @tsv --show-toplevel /opt/hostedtoolcache/go/1.25.8/x64/pkg/tool/linuInitial commit /usr/bin/git 28 /tmp/go-build415rev-parse /usr/bin/git git rev-�� --show-toplevel git /usr/bin/git ithub-script/gitgh show ache/node/24.14./repos/actions/github-script/git/ref/tags/v9 git (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/ai-inference/git/ref/tags/v1 --jq [.object.sha, .object.type] | @tsv --show-toplevel node /usr/bin/git sistency_KeyOrdegit scripts/**/*.js /opt/hostedtoolc--show-toplevel git rev-�� --show-toplevel /opt/hostedtoolc--jq /usr/bin/git 75 gh ache/node/24.14./repos/actions/github-script/git/ref/tags/v9 git (http block)
  • https://api.github.com/repos/actions/checkout/git/ref/tags/v3
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v3 --jq [.object.sha, .object.type] | @tsv WorkflowFiles_TransitiveImports2731036087/001 remote1 (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v3 --jq [.object.sha, .object.type] | @tsv /ref/tags/v9 test@example.com sv --show-toplevel git 64/bin/gofmt git remo�� remove remote1 me: String!) { repository(owner: $owner, name: $name) { hasDiscussionsEnabled } } te '**/*.cjs' '*git est.go 1/x64/bin/sh git (http block)
  • https://api.github.com/repos/actions/checkout/git/ref/tags/v5
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v5 --jq [.object.sha, .object.type] | @tsv t0 -buildtags .cfg m0s -ifaceassert (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v5 --jq [.object.sha, .object.type] | @tsv ithub-script/git/ref/tags/v9 git bject.type] | @tsv k/gh-aw/gh-aw/.ggit (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v5 --jq [.object.sha, .object.type] | @tsv --show-toplevel infocmp /usr/bin/git xterm-color ache/go/1.25.8/xrev-parse /usr/bin/git git rev-�� /ref/tags/v9 git sv --show-toplevel /opt/hostedtoolcrev-parse /usr/bin/infocmp--show-toplevel gh (http block)
  • https://api.github.com/repos/actions/checkout/git/ref/tags/v6
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v6 --jq [.object.sha, .object.type] | @tsv 0731742/b462/_pkg_.a -trimpath (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v6 --jq [.object.sha, .object.type] | @tsv /tmp/go-build4150731742/b441/_pkg_.a -trimpath /opt/hostedtoolcache/go/1.25.8/x64/pkg/tool/linux_amd64/compile -p github.com/githurev-parse -lang=go1.25 /opt/hostedtoolcache/go/1.25.8/x--jq -o /tmp/go-build4150731742/b453/_pkg_.a -trimpath /usr/bin/git -p main -lang=go1.25 git (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v6 --jq [.object.sha, .object.type] | @tsv ansitiveImports2731036087/001 x_amd64/compile /usr/bin/git (http block)
  • https://api.github.com/repos/actions/github-script/git/ref/tags/v8
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v8 --jq [.object.sha, .object.type] | @tsv --show-toplevel /opt/hostedtoolcache/node/24.14.1/x64/bin/node /usr/bin/git github.actor x_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v8 --jq [.object.sha, .object.type] | @tsv --show-toplevel git /usr/bin/git --show-toplevel infocmp (http block)
  • https://api.github.com/repos/actions/github-script/git/ref/tags/v9
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9 --jq [.object.sha, .object.type] | @tsv (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9 --jq [.object.sha, .object.type] | @tsv go1.25.8 -c=4 -nolocalimports -importcfg /tmp/go-build4150731742/b395/importcfg -pack /tmp/go-build4150731742/b395/_testmain.go (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9 --jq [.object.sha, .object.type] | @tsv th .prettierigno-errorsas (http block)
  • https://api.github.com/repos/actions/github-script/git/ref/tags/v9.0.0
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9.0.0 --jq [.object.sha, .object.type] | @tsv (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9.0.0 --jq [.object.sha, .object.type] | @tsv d -n 10 (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9.0.0 --jq [.object.sha, .object.type] | @tsv cp .github/aw/ac-errorsas (http block)
  • https://api.github.com/repos/actions/setup-go/git/ref/tags/v4
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-go/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv --show-toplevel /opt/hostedtoolcache/go/1.25.8/x^remote\..*\.gh-resolved$ /usr/bin/gh -bool -buildtags 0731742/b207/vetxterm-color gh api /repos/actions/github-script/git/ref/tags/v9 --jq /usr/bin/git '/tmp/TestParseDgit '/tmp/TestParseDrev-parse /opt/hostedtoolc--show-toplevel git (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-go/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv get-url origin /usr/bin/git CommaSeparatedCogh on 1/x64/bin/node git rev-�� --show-toplevel 1/x64/bin/node /usr/bin/git 2928234744 git (http block)
  • https://api.github.com/repos/actions/setup-node/git/ref/tags/v4
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv /home/REDACTED/work/gh-aw/gh-aw/.github/workflows/archie.md x_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv --show-toplevel /opt/hostedtoolcache/go/1.25.8/x64/pkg/tool/linu--jq /usr/bin/infocmp 5801-14483/test-gh /tmp/go-build415api e/git infocmp -1 xterm-color e/git /usr/bin/git -unreachable=falgit /tmp/go-build415rev-parse ache/node/24.14.--show-toplevel git (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv --show-toplevel dv/0iVq0hSVi8Dx-47B7OzK/q5ithrw5KKkIAF4GTOcE /usr/bin/git /tmp/TestGuardPogit config /usr/bin/git git rev-�� /ref/tags/v9 git sv /tmp/gh-aw-test-infocmp git 64/pkg/tool/linuxterm-color gh (http block)
  • https://api.github.com/repos/actions/setup-node/git/ref/tags/v6
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v6 --jq [.object.sha, .object.type] | @tsv runs/20260506-225801-14483/test-71208822 -importcfg ache/node/24.14.1/x64/bin/node l -w -buildmode=exe /usr/lib/git-core/git t-23�� k/gh-aw/gh-aw/.github/workflows/ace-editor.md --stdin ache/node/24.14.1/x64/bin/node --exclude-hiddengit --all --quiet ache/node/24.14.1/x64/bin/node (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v6 --jq [.object.sha, .object.type] | @tsv v1.0.0 /tmp/go-build4150731742/b428/_teowner=github /opt/hostedtoolcache/go/1.25.8/x-f (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v6 --jq [.object.sha, .object.type] | @tsv (http block)
  • https://api.github.com/repos/actions/upload-artifact/git/ref/tags/v4
    • Triggering command: /usr/bin/gh gh api /repos/actions/upload-artifact/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv xterm-color x_amd64/vet /usr/bin/git */*.ts' '**/*.jsgit (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/upload-artifact/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv /tmp/TestCompileUpdateDiscussionFieldEnforcement2594723156/001 l /usr/bin/git remote.origin.urgit git (http block)
  • https://api.github.com/repos/aws-actions/configure-aws-credentials/git/ref/tags/v4
    • Triggering command: /usr/bin/gh gh api /repos/aws-actions/configure-aws-credentials/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv --show-toplevel /opt/hostedtoolcache/go/1.25.8/x64/pkg/tool/linux_amd64/compile /usr/bin/git /tmp/go-build415git -trimpath /opt/hostedtoolc--show-toplevel git rev-�� --show-toplevel /opt/hostedtoolcache/go/1.25.8/x64/pkg/tool/linux_amd64/compile /usr/bin/git /tmp/go-build415gh -trimpath /usr/bin/git git (http block)
    • Triggering command: /usr/bin/gh gh api /repos/aws-actions/configure-aws-credentials/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv --show-toplevel git /usr/bin/git --show-toplevel (http block)
    • Triggering command: /usr/bin/gh gh api /repos/aws-actions/configure-aws-credentials/git/ref/tags/v4 --jq [.object.sha, .object.type] | @tsv --show-toplevel /opt/hostedtoolcache/go/1.25.8/x64/pkg/tool/linux_amd64/link /usr/bin/git /tmp/go-build253git -importcfg /opt/hostedtoolc--show-toplevel git rev-�� --show-toplevel node /usr/bin/git /home/REDACTED/worgh -extld=gcc /usr/bin/git git (http block)
  • https://api.github.com/repos/azure/login/git/ref/tags/v2
    • Triggering command: /usr/bin/gh gh api /repos/azure/login/git/ref/tags/v2 --jq [.object.sha, .object.type] | @tsv --show-toplevel ache/node/24.14.1/x64/bin/node /usr/bin/git github.repositorgit rev-parse /usr/bin/git git rev-�� --show-toplevel git /usr/bin/git mpleWorkflow2454infocmp (http block)
    • Triggering command: /usr/bin/gh gh api /repos/azure/login/git/ref/tags/v2 --jq [.object.sha, .object.type] | @tsv --show-toplevel gh /usr/bin/git /repos/actions/ggit --jq /usr/bin/git git rev-�� --show-toplevel git /usr/bin/git /tmp/compile-allinfocmp remote /usr/bin/git git (http block)
  • https://api.github.com/repos/docker/login-action/git/ref/tags/v3
    • Triggering command: /usr/bin/gh gh api /repos/docker/login-action/git/ref/tags/v3 --jq [.object.sha, .object.type] | @tsv --show-toplevel ache/node/24.14.1/x64/bin/node /usr/bin/git /tmp/TestHashCongit (http block)
    • Triggering command: /usr/bin/gh gh api /repos/docker/login-action/git/ref/tags/v3 --jq [.object.sha, .object.type] | @tsv --show-toplevel git /usr/bin/git /tmp/gh-aw-test-git l /opt/hostedtoolc--show-toplevel git rev-�� --show-toplevel node /usr/bin/infocmp /home/REDACTED/worinfocmp git /usr/bin/git infocmp (http block)
  • https://api.github.com/repos/github/gh-aw-actions/git/ref/tags/v0.1.2
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v0.1.2 --jq [.object.sha, .object.type] | @tsv /repos/actions/github-script/git/ref/tags/v9 --jq /usr/bin/gh SameOutput340717infocmp /tmp/go-build415-1 e/git-receive-paxterm-color gh api /repos/actions/github-script/git/ref/tags/v9 --jq /usr/bin/git -unreachable=falinfocmp /tmp/go-build415-1 0731742/b436/repxterm-color git (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v0.1.2 --jq [.object.sha, .object.type] | @tsv --show-toplevel /opt/hostedtoolcache/go/1.25.8/xTest User /usr/bin/git te '../../../**/git gh ache/go/1.25.8/x--show-toplevel git rev-�� --show-toplevel ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet /usr/bin/git log.showsignaturinfocmp log e/git git (http block)
  • https://api.github.com/repos/github/gh-aw-actions/git/ref/tags/v1.0.0
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v1.0.0 --jq [.object.sha, .object.type] | @tsv -pack /tmp/go-build4150731742/b448/_testmain.go /usr/bin/git --get-regexp --global x_amd64/vet git rev-�� --show-toplevel x_amd64/vet r,url,status,conclusion,workflowName,createdAt,startedAt,updatedAt,event,headBranch,headSha,disp--show-toplevel ub/workflows flow 64/pkg/tool/linu--show-toplevel git (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v1.0.0 --jq [.object.sha, .object.type] | @tsv /ref/tags/v9 g/cli sv --show-toplevel git 64/bin/node git conf�� user.email test@example.com /usr/bin/git lGitbranch_with_git lGitbranch_with_rev-parse layTitle git (http block)
  • https://api.github.com/repos/github/gh-aw-actions/git/ref/tags/v1.2.3
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v1.2.3 --jq [.object.sha, .object.type] | @tsv --get remote.origin.url /opt/hostedtoolcache/node/24.14.1/x64/bin/node --get-regexp --global x_amd64/vet /opt/hostedtoolcache/node/24.14.1/x64/bin/node /tmp�� github.actor && secrets.TOKEN x_amd64/vet r,url,status,conclusion,workflowName,createdAt,startedAt,updatedAt,event,headBranch,headSha,disp--show-toplevel b/workflows flow-12345 x_amd64/compile git (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v1.2.3 --jq [.object.sha, .object.type] | @tsv --get remote.origin.url /usr/bin/git --show-toplevel git n-dir/node git remo�� /usr/bin/gh git /usr/bin/git ithub-script/gitgit gh bject.type] | @t--show-toplevel git (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs
    • Triggering command: /usr/bin/gh gh run list --json databaseId,number,url,status,conclusion,workflowName,createdAt,startedAt,updatedAt,event,headBranch,headSha,displayTitle --limit 100 --created >=2026-04-29 (http block)
    • Triggering command: /usr/bin/gh gh run list --json databaseId,number,url,status,conclusion,workflowName,createdAt,startedAt,updatedAt,event,headBranch,headSha,displayTitle --limit 100 --created >=2026-04-06 (http block)
    • Triggering command: /usr/bin/gh gh run list --json databaseId,number,url,status,conclusion,workflowName,createdAt,startedAt,updatedAt,event,headBranch,headSha,displayTitle --limit 100 --created >=2026-02-05 (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/1/artifacts
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/1/artifacts --jq .artifacts[].name on ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet /../../.prettiergh erignore (http block)
    • Triggering command: /usr/bin/gh gh run download 1 --dir test-logs/run-1 (http block)
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/1/artifacts --jq .artifacts[].name bash b1f44553122efa55d6b0faeb9e79011523b9c57ab2356ef4c52386a04e8974d5-d /usr/bin/git git /usr/bin/git node ache�� /ref/tags/v9 ../../../**/*.json sv rkflow/js/**/*.jgit ../../../.prettirev-parse erignore bash (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/12345/artifacts
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/12345/artifacts --jq .artifacts[].name (http block)
    • Triggering command: /usr/bin/gh gh run download 12345 --dir test-logs/run-12345 .cfg .cfg (http block)
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/12345/artifacts --jq .artifacts[].name **/*.cjs .cfg **/*.json --ignore-path ../../../.pretti--show-toplevel erignore -c 0215-27574/test-3795718382/.github/workflows infocmp 1/x64/bin/node rror git /usr/bin/git ache/go/1.25.8/x64/pkg/tool/linu--auto (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/1234567890
    • Triggering command: /usr/bin/gh gh api repos/{owner}/{repo}/actions/runs/1234567890 --jq {databaseId: .id, number: .run_number, url: .html_url, status: .status, conclusion: .conclusion, workflowName: .name, workflowPath: .path, createdAt: .created_at, startedAt: .run_started_at, updatedAt: .updated_at, event: .event, headBranch: .head_branch, on' --ignore-path ../../../.prettierignore (http block)
    • Triggering command: /usr/bin/gh gh api repos/{owner}/{repo}/actions/runs/1234567890 --jq {databaseId: .id, number: .run_number, url: .html_url, status: .status, conclusion: .conclusion, workflowName: .name, workflowPath: .path, createdAt: .created_at, startedAt: .run_started_at, updatedAt: .updated_at, event: .event, headBranch: .head_branch, h ../../../.pret.prettierignore --jq de ithub-script/git/opt/hostedtoolcache/go/1.25.8/x64/pkg/tool/linux_amd64/cgo git bject.type] | @tsv git rev-�� ../pkg/workflow/js/**/*.json' --ignore-path ../../../.prettierignore git /usr/bin/git --show-toplevel infocmp /usr/bin/gh git (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/12346/artifacts
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/12346/artifacts --jq .artifacts[].name (http block)
    • Triggering command: /usr/bin/gh gh run download 12346 --dir test-logs/run-12346 (http block)
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/12346/artifacts --jq .artifacts[].name **/*.cjs .cfg **/*.json --ignore-path ../../../.pretti--show-toplevel erignore -c 0215-27574/test-3795718382/.github/workflows git ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet rror git /usr/bin/gh ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/2/artifacts
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/2/artifacts --jq .artifacts[].name on ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet /../../.prettierinfocmp erignore (http block)
    • Triggering command: /usr/bin/gh gh run download 2 --dir test-logs/run-2 .cfg ache/go/1.25.8/x64/pkg/tool/linu-lang=go1.25 /../../.prettiergit (http block)
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/2/artifacts --jq .artifacts[].name efaultBranchFromLsRemoteWithRealGitmaster_branch1267219863/001' Name,createdAt,startedAt,updatedAt,event,headBranch,headSha,displayTitle . git /usr/bin/git sh ache�� 0215-27574/test-2919149211/.github/workflows git 1/x64/bin/node rkflow/js/**/*.jgit infocmp erignore bash (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/3/artifacts
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/3/artifacts --jq .artifacts[].name on 64/pkg/tool/linux_amd64/vet /../../.prettier/usr/bin/git erignore (http block)
    • Triggering command: /usr/bin/gh gh run download 3 --dir test-logs/run-3 0731742/b009/vet.cfg ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet /../../.prettiergit (http block)
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/3/artifacts --jq .artifacts[].name git k/gh-aw/node_modules/.bin/node -m Branch commit /usr/bin/git prettier ache�� 0215-27574/test-2919149211/.github/workflows !../../../pkg/workflow/js/**/*.json on rkflow/js/**/*.jgit gh erignore bash (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/4/artifacts
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/4/artifacts --jq .artifacts[].name on ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet /../../.prettier/usr/bin/git erignore (http block)
    • Triggering command: /usr/bin/gh gh run download 4 --dir test-logs/run-4 .cfg ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/4/artifacts --jq .artifacts[].name /usr/lib/git-core/git k/node_modules/.bin/node run --auto (http block)
  • https://api.github.com/repos/github/gh-aw/actions/runs/5/artifacts
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/5/artifacts --jq .artifacts[].name .cfg ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet /../../.prettiergh erignore (http block)
    • Triggering command: /usr/bin/gh gh run download 5 --dir test-logs/run-5 .cfg ache/go/1.25.8/x64/pkg/tool/linu-nilfunc /../../.prettiergit (http block)
    • Triggering command: /usr/bin/gh gh api --paginate repos/{owner}/{repo}/actions/runs/5/artifacts --jq .artifacts[].name git es/.bin/node HEAD git /usr/bin/git node ache�� --write ../../../**/*.json on rkflow/js/**/*.jgit ../../../.prettirev-parse erignore bash (http block)
  • https://api.github.com/repos/github/gh-aw/actions/workflows
    • Triggering command: /usr/bin/gh gh workflow list --json name,state,path on' --ignore-path ../../../.pret.prettierignore (http block)
    • Triggering command: /usr/bin/gh gh run list --json databaseId,number,url,status,conclusion,workflowName,createdAt,startedAt,updatedAt,event,headBranch,headSha,displayTitle --workflow nonexistent-workflow-12345 --limit 100 (http block)
    • Triggering command: /usr/bin/gh gh run list --json databaseId,number,url,status,conclusion,workflowName,createdAt,startedAt,updatedAt,event,headBranch,headSha,displayTitle --workflow nonexistent-workflow-12345 --limit 6 (http block)
  • https://api.github.com/repos/github/gh-aw/contents/.github/workflows/shared/reporting.md
    • Triggering command: /tmp/go-build4150731742/b404/cli.test /tmp/go-build4150731742/b404/cli.test -test.testlogfile=/tmp/go-build4150731742/b404/testlog.txt -test.paniconexit0 -test.v=true -test.parallel=4 -test.timeout=10m0s -test.run=^Test -test.short=true (http block)
    • Triggering command: /tmp/go-build2531489478/b404/cli.test /tmp/go-build2531489478/b404/cli.test -test.testlogfile=/tmp/go-build2531489478/b404/testlog.txt -test.paniconexit0 -test.v=true -test.parallel=4 -test.timeout=10m0s -test.run=^Test -test.short=true --show-toplevel git /usr/bin/git git rev-�� json' --ignore-p**/*.ts git /prettier /ref/tags/v9 /usr/bin/git sv git (http block)
  • https://api.github.com/repos/github/gh-aw/git/ref/tags/v0.47.4
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v0.47.4 --jq [.object.sha, .object.type] | @tsv --show-toplevel node /usr/bin/git 2" 1>&2 s/test.md rue,"errors":[],/tmp/gh-aw/aw-feature-branch.patch git rev-�� --show-toplevel git /usr/bin/infocmp (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v0.47.4 --jq [.object.sha, .object.type] | @tsv --show-toplevel git /usr/bin/git /tmp/TestGuardPodu rev-parse /opt/hostedtoolc/tmp/gh-aw/aw-feature-branch.patch git rev-�� --show-toplevel /opt/hostedtoolcache/node/24.14.1/x64/bin/node /usr/bin/infocmp s/test.md 64/bin/gofmt /usr/bin/git infocmp (http block)
  • https://api.github.com/repos/github/gh-aw/git/ref/tags/v1.0.0
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v1.0.0 --jq [.object.sha, .object.type] | @tsv sRemoteWithRealGitmaster_branch1310045414/001 sRemoteWithRealGitmaster_branch1310045414/002/work ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet **/*.json --ignore-path ../../../.prettixterm-color ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet ortc�� se stmain.go ingutil.test rror (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v1.0.0 --jq [.object.sha, .object.type] | @tsv iant-2650863526 git ode_modules/.bin/node --show-toplevel gh (http block)
  • https://api.github.com/repos/github/gh-aw/git/ref/tags/v1.2.3
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v1.2.3 --jq [.object.sha, .object.type] | @tsv */*.ts' '**/*.js-c=4 (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v1.2.3 --jq [.object.sha, .object.type] | @tsv le-frontmatter.md git ules/.bin/node --show-toplevel git bash git ules�� */*.json' '!../../../pkg/workflow/js/**/*.json' --ignore-path ../../../.prettierignore infocmp /sadc xterm-color git /usr/bin/git /sadc (http block)
  • https://api.github.com/repos/github/gh-aw/git/ref/tags/v2.0.0
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v2.0.0 --jq [.object.sha, .object.type] | @tsv */*.ts' '**/*.json' --ignore-path ../../../.prettierignore (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v2.0.0 --jq [.object.sha, .object.type] | @tsv */*.ts' '**/*.json' --ignore-path ../../../.pret.prettierignore (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v2.0.0 --jq [.object.sha, .object.type] | @tsv lex-frontmatter-with-tools.md git tions/node_modules/.bin/node --show-toplevel gh /usr/bin/infocmp--show-toplevel git ules�� --show-toplevel infocmp bin/bash son git /usr/bin/gh pins synced succonfig (http block)
  • https://api.github.com/repos/github/gh-aw/git/ref/tags/v3.0.0
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v3.0.0 --jq [.object.sha, .object.type] | @tsv go1.25.8 -c=4 -nolocalimports -importcfg /tmp/go-build4150731742/b460/importcfg -pack /tmp/go-build4150731742/b460/_testmain.go conf�� ub/workflows --local x_amd64/compile credential.userngit (http block)
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v3.0.0 --jq [.object.sha, .object.type] | @tsv json' --ignore-path ../../../.pr--ignore-path --jq 1/x64/lib/node_modules/npm/node_--log-level=error --show-toplevel gh /usr/bin/infocmp/tmp/TestGuardPolicyMinIntegrityOnlymin-integrity_with_explicit_repo4240246411/001 git ules�� --show-toplevel infocmp nfig/composer/vendor/bin/bash son gh /usr/bin/infocmpgithub.repository git (http block)
  • https://api.github.com/repos/google-github-actions/auth/git/ref/tags/v2
    • Triggering command: /usr/bin/gh gh api /repos/google-github-actions/auth/git/ref/tags/v2 --jq [.object.sha, .object.type] | @tsv --show-toplevel ache/node/24.14.1/x64/bin/node /usr/bin/git /tmp/TestHashCongit -extld=gcc /usr/bin/gh git rev-�� --show-toplevel gh /usr/bin/git /repos/actions/ggit --jq /usr/bin/git git (http block)
    • Triggering command: /usr/bin/gh gh api /repos/google-github-actions/auth/git/ref/tags/v2 --jq [.object.sha, .object.type] | @tsv --show-toplevel git /usr/bin/git /tmp/gh-aw-test-git config om/testowner/tes--show-toplevel git rev-�� --show-toplevel git /usr/bin/git --show-toplevel gh (http block)
  • https://api.github.com/repos/nonexistent/action/git/ref/tags/v999.999.999
    • Triggering command: /usr/bin/gh gh api /repos/nonexistent/action/git/ref/tags/v999.999.999 --jq [.object.sha, .object.type] | @tsv --write **/*.cjs ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet **/*.json --ignore-path ../../../.pretti--get-regexp ache/go/1.25.8/x^remote\..*\.gh-resolved$ (http block)
    • Triggering command: /usr/bin/gh gh api /repos/nonexistent/action/git/ref/tags/v999.999.999 --jq [.object.sha, .object.type] | @tsv ithub-script/git--detach git ules/.bin/sh --show-toplevel git /usr/bin/infocmpxterm-color git rev-�� th .prettierignore --log-level=e!../../../pkg/workflow/js/**/*.json infocmp 64/bin/go /ref/tags/v9 gh sv time/copilot-devrev-parse (http block)
  • https://api.github.com/repos/nonexistent/repo/actions/runs/12345
    • Triggering command: /usr/bin/gh gh run view 12345 --repo nonexistent/repo --json status,conclusion ./../.prettieriggit gh/go-spew/spew (http block)
    • Triggering command: /usr/bin/gh gh run view 12345 --repo nonexistent/repo --json status,conclusion rror --jq (http block)
  • https://api.github.com/repos/owner/repo/actions/workflows
    • Triggering command: /usr/bin/gh gh workflow list --json name,state,path --repo owner/repo node hub.com/.extrahe/opt/hostedtoolcache/go/1.25.8/x64/pkg/tool/linux_amd64/vet (http block)
    • Triggering command: /usr/bin/gh gh workflow list --json name,state,path --repo owner/repo tnet/tools/git hub.com/.extrahe/opt/hostedtoolcache/go/1.25.8/x64/pkg/tool/linux_amd64/compile (http block)
    • Triggering command: /usr/bin/gh gh workflow list --repo owner/repo --json name,path,state ache/go/1.25.8/x64/pkg/tool/linux_amd64/vet (http block)
  • https://api.github.com/repos/test-owner/test-repo/actions/secrets
    • Triggering command: /usr/bin/gh gh api /repos/test-owner/test-repo/actions/secrets --jq .secrets[].name on' --ignore-path ../../../.pret.prettierignore (http block)
    • Triggering command: /usr/bin/gh gh api /repos/test-owner/test-repo/actions/secrets --jq .secrets[].name /ref/tags/v9 git sv --show-toplevel git /usr/bin/git git rev-�� w/js/**/*.json' --ignore-path git (http block)
  • https://api.github.com/repos/test/repo
    • Triggering command: /usr/bin/gh gh api /repos/test/repo --jq .default_branch t1415899199/.github/workflows (http block)
    • Triggering command: /usr/bin/gh gh api /repos/test/repo --jq .default_branch ithub-script/git/ref/tags/v9 -buildtags bject.type] | @tsv -errorsas -ifaceassert -nilfunc /usr/lib/git-core/git main�� run --auto ache/node/24.14.1/x64/bin/node --detach git /usr/bin/git ache/node/24.14.1/x64/bin/node (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Agent-Logs-Url: https://github.com/github/gh-aw/sessions/5fe29294-f2e5-4b9a-a369-79ab036d5a9e

Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix inconsistencies in CLI help text documentation Align CLI help text semantics and terminology across mcp, project, pr, completion, logs, and init May 6, 2026
Copilot AI requested a review from gh-aw-bot May 6, 2026 23:05
@pelikhan pelikhan marked this pull request as ready for review May 6, 2026 23:14
Copilot AI review requested due to automatic review settings May 6, 2026 23:14
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Normalizes CLI command help text semantics/terminology across several commands and updates unit tests to pin the new help-text contracts.

Changes:

  • Updated project and pr parent command descriptions to better match their current subcommand scope.
  • Clarified mcp inspect no-argument behavior, standardized completion shell name casing, refined logs --after cache-maintenance examples, and cleaned up init --codespaces grammar.
  • Added/updated command tests to assert the revised help text.
Show a summary per file
File Description
pkg/cli/project_command.go Updates project Short/Long help to be creation-focused.
pkg/cli/project_command_test.go Adjusts assertions to match the updated project help text.
pkg/cli/pr_command.go Tweaks pr long description wording to singular “tool”.
pkg/cli/pr_command_test.go Adds assertion to pin updated pr long help wording.
pkg/cli/mcp_inspect.go Documents mcp inspect no-arg behavior in long help.
pkg/cli/mcp_inspect_test.go Adds test asserting mcp inspect no-arg behavior is documented.
pkg/cli/logs_command.go Updates logs --after examples to describe cache eviction semantics.
pkg/cli/logs_command_test.go Adds assertion for updated cache-maintenance example wording.
pkg/cli/init_command.go Refines --codespaces flag help grammar.
pkg/cli/init_command_test.go Adds assertion for updated --codespaces usage text.
pkg/cli/completion_command.go Changes supported shell list casing to “PowerShell” in long help.
pkg/cli/completion_command_test.go Updates long-help assertion to expect “PowerShell” casing.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comments suppressed due to low confidence (1)

pkg/cli/completion_command.go:50

  • The long help now lists “PowerShell” with that casing, but the command still only accepts the lowercase argument powershell due to ValidArgs + cobra.OnlyValidArgs (case-sensitive). This makes the help text potentially misleading. Either keep the supported-shells list in lowercase to match accepted args, or accept case-insensitive input (e.g., include "PowerShell" in ValidArgs and normalize args[0] before the switch).
Supported shells: bash, zsh, fish, PowerShell

Examples:
  # Install completions automatically (detects your shell)
  gh aw completion install

  # Generate completion script for bash
  gh aw completion bash > ~/.bash_completion.d/gh-aw
  source ~/.bash_completion.d/gh-aw

  # Generate completion script for zsh
  gh aw completion zsh > "${fpath[1]}/_gh-aw"
  compinit

  # Generate completion script for fish
  gh aw completion fish > ~/.config/fish/completions/gh-aw.fish

  # Generate completion script for PowerShell
  gh aw completion powershell | Out-String | Invoke-Expression

  # Add to PowerShell profile for persistent completions
  echo 'gh aw completion powershell | Out-String | Invoke-Expression' >> $PROFILE`,
		ValidArgs: []string{"bash", "zsh", "fish", "powershell"},
		Args:      cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs),
  • Files reviewed: 12/12 changed files
  • Comments generated: 0

@pelikhan pelikhan merged commit 4a7f7cd into main May 6, 2026
4 checks passed
@pelikhan pelikhan deleted the copilot/cli-consistency-fixes branch May 6, 2026 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[cli-consistency] CLI Consistency Issues - 2026-05-06

4 participants