fix: resolve 8 CLI consistency issues from automated inspection#24130
Merged
fix: resolve 8 CLI consistency issues from automated inspection#24130
Conversation
- Fix incorrect URL in project new (github.github.com → github.github.io) - Fix logs --timeout unit from seconds to minutes (consistent with trial --timeout) - Update MCP server default timeout from 50s to 1 minute accordingly - Fix validate --stats description to match compile --stats detail - Fix validate --strict description to match compile --strict detail - Fix lowercase github → GitHub in init command help text - Fix redundant wording in audit diff short description - Add URL to secrets bootstrap documentation reference - Add --interactive/-i flag to new command options in CLI docs - Update timeout tests to reflect minutes-based behavior Agent-Logs-Url: https://github.com/github/gh-aw/sessions/82e71b9d-4f7b-4f3e-8d7d-82dbcabc143a Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Agent-Logs-Url: https://github.com/github/gh-aw/sessions/82e71b9d-4f7b-4f3e-8d7d-82dbcabc143a Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix CLI consistency issues in command help text
fix: resolve 8 CLI consistency issues from automated inspection
Apr 2, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR addresses a set of automated CLI consistency findings across command help text, flag descriptions, URLs, documentation, and the logs --timeout unit semantics.
Changes:
- Fix and standardize CLI/docs text (URLs, capitalization, redundant phrasing, and missing options).
- Align
validateflag descriptions (--strict,--stats) with the more detailed wording expected for parity. - Standardize
logs --timeoutto minutes (including MCP logs tool default) and update timeout logic/tests accordingly.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pkg/cli/validate_command.go | Expands --strict and --stats flag descriptions for consistency with expected wording. |
| pkg/cli/tokens_bootstrap.go | Replaces vague docs pointer with a concrete tokens reference URL. |
| pkg/cli/project_command.go | Fixes broken auth-projects reference URL domain. |
| pkg/cli/mcp_tools_privileged.go | Updates MCP logs tool timeout schema/help and defaults to minutes (default 1). |
| pkg/cli/logs_timeout_test.go | Updates timeout-related tests to minutes semantics and adds a boundary case. |
| pkg/cli/logs_orchestrator.go | Updates user-facing timeout text and converts timeout comparisons to minutes. |
| pkg/cli/logs_command.go | Updates --timeout flag help text to minutes. |
| pkg/cli/init_command.go | Fixes capitalization (“GitHub”). |
| pkg/cli/audit_diff_command.go | Tightens short description to remove redundant wording. |
| docs/src/content/docs/setup/cli.md | Documents new command --interactive/-i option in the options list. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Automated CLI consistency checker flagged 8 issues across help text, flag descriptions, and documentation covering broken URLs, inconsistent units, capitalization, and missing content.
Changes
High severity
project new: fix doubled domain in auth URL (github.github.com→github.github.io)logs --timeout: standardize to minutes (was seconds;trial --timeoutuses minutes). Updateslogs_orchestrator.gocomparison (elapsed >= float64(timeout)*60) and MCP server default from 50s → 1 minuteFlag description parity (
validatevscompile)--stats: add "(shows jobs, steps, scripts, and shells)" to match compile's description--strict: expand terse description to match compile's full explanation (action pinning, network config, safe-outputs, write permission refusal, frontmatter override semantics)Medium/Low
init:github→GitHubin long description bodyaudit diffshort desc: "Compare workflow run behavior across two workflow runs" → "Compare behavior across two workflow runs" (removes redundant "workflow run")secrets bootstrap: replace vague "see the documentation" with concrete URL (https://github.github.io/gh-aw/reference/tokens/)docs/setup/cli.mdnewcommand: add missing--interactive/-ito Options listTest updates
logs_timeout_test.goupdated to reflect minutes semantics, including an added boundary case (59s elapsed, 1min timeout → no timeout).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/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 GO111MODULE x_amd64/compile git rev-�� --show-toplevel x_amd64/compile /usr/bin/git g_.a GOPROXY /home/REDACTED/.lo--show-toplevel git(http block)https://api.github.com/orgs/test-owner/actions/secrets/usr/bin/gh gh api /orgs/test-owner/actions/secrets --jq .secrets[].name w/js/**/*.json' --ignore-path GO111MODULE 64/bin/go GOINSECURE GOMOD GOMODCACHE go env -json GO111MODULE ode_modules/.bin/sh GOINSECURE GOMOD GOMODCACHE go(http block)https://api.github.com/repos/actions/ai-inference/git/ref/tags/v1/usr/bin/gh gh api /repos/actions/ai-inference/git/ref/tags/v1 --jq .object.sha --show-toplevel x_amd64/compile /opt/hostedtoolcache/node/24.14.1/x64/bin/node ub/workflows GO111MODULE(http block)https://api.github.com/repos/actions/checkout/git/ref/tags/v3/usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v3 --jq .object.sha -test.paniconexit0 l /usr/lib/git-core/git -test.timeout=10git -test.run=^Test -test.short=true--show-toplevel /usr/lib/git-core/git --gi�� for-each-ref --format=%(objectname) /usr/bin/git w/js/**/*.json' git GO111MODULE 64/bin/go git(http block)https://api.github.com/repos/actions/checkout/git/ref/tags/v5/usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v5 --jq .object.sha 2444488011 ne_constants.go 64/pkg/tool/linux_amd64/vet GOINSECURE GOMOD GOMODCACHE 64/pkg/tool/linux_amd64/vet test�� 71/001/test-frontmatter-with-nesremote.origin.url TestLogsOrchestrator|TestTimeout-nolocalimports k/node_modules/.bin/node GOSUMDB GOWORK 64/bin/go bash(http block)/usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v5 --jq .object.sha -v x_amd64/link /usr/bin/git .js' --ignore-pagit GO111MODULE x_amd64/compile git rev-�� --show-toplevel x_amd64/compile /usr/bin/git -json GO111MODULE f0c82044839689f7--show-toplevel git(http block)/usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v5 --jq .object.sha --show-toplevel node /usr/bin/git agent-performancgit --write 64/pkg/tool/linu--show-toplevel git rev-�� --show-toplevel 64/pkg/tool/linux_amd64/compile /usr/bin/git g_.a node 6437912/b417=> git(http block)https://api.github.com/repos/actions/checkout/git/ref/tags/v6/usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v6 --jq .object.sha --show-toplevel go r,url,status,conclusion,workflowName,createdAt,startedAt,updated-test.short=true th .prettierignogit flow-12345 ode_modules/.bin--show-toplevel git chec�� .github/workflows/test.md eDXfSXk/Kh5wiGQgconfig /usr/bin/git -json GO111MODULE 64/bin/node git(http block)/usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v6 --jq .object.sha -bool -buildtags /usr/bin/git -errorsas -ifaceassert -nilfunc git conf�� --get remote.origin.url /usr/bin/git -json GO111MODULE ache/go/1.25.0/x--show-toplevel git(http block)/usr/bin/gh gh api /repos/actions/checkout/git/ref/tags/v6 --jq .object.sha --show-toplevel bash /usr/bin/git 5821-30459/test-git go /home/REDACTED/wor--show-toplevel git rev-�� --show-toplevel sh /usr/bin/git "prettier" --wrigit go 64/pkg/tool/linu--show-toplevel git(http block)https://api.github.com/repos/actions/github-script/git/ref/tags/v8/usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v8 --jq .object.sha -json GO111MODULE 64/bin/go GOINSECURE GOMOD GOMODCACHE go env -json GO111MODULE x_amd64/cgo GOINSECURE GOMOD GOMODCACHE x_amd64/cgo(http block)/usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v8 --jq .object.sha ut GO111MODULE 64/bin/go GOINSECURE GOMOD GOMODCACHE go env json' --ignore-p-p GO111MODULE odules/npm/node_-lang=go1.25 GOINSECURE GOMOD GOMODCACHE go(http block)/usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v8 --jq .object.sha -json GO111MODULE 64/bin/go GOINSECURE GOMOD GOMODCACHE go env -json GO111MODULE de/node/bin/bash-lang=go1.25 GOINSECURE GOMOD GOMODCACHE go(http block)https://api.github.com/repos/actions/setup-go/git/ref/tags/v4/usr/bin/gh gh api /repos/actions/setup-go/git/ref/tags/v4 --jq .object.sha --show-toplevel resolved$ /usr/bin/git th .prettierignogit GO111MODULE es/.bin/node git remo�� add origin /usr/bin/git -json GO111MODULE tions/node_modul--show-toplevel git(http block)https://api.github.com/repos/actions/setup-node/git/ref/tags/v4/usr/bin/gh gh api /repos/actions/setup-node/git/ref/tags/v4 --jq .object.sha GOMODCACHE go /usr/bin/git th .prettierignogit GO111MODULE ode_modules/.bin--show-toplevel git init�� GOMODCACHE go /opt/hostedtoolcache/node/24.14.1/x64/bin/node -json GO111MODULE(http block)https://api.github.com/repos/github/gh-aw-actions/git/ref/tags/v0.1.2/usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v0.1.2 --jq .object.sha --show-toplevel go /usr/bin/git -json GO111MODULE 64/bin/bash git -C /tmp/gh-aw-test-runs/20260402-145821-30459/test-3343007444 rev-parse /usr/bin/git @{u} GO111MODULE 64/bin/gofmt git(http block)https://api.github.com/repos/github/gh-aw-actions/git/ref/tags/v1.0.0/usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v1.0.0 --jq .object.sha licyMinIntegrityOnlymin-integrity_with_repos=public_2166583631/001 go 1/x64/bin/node l GO111MODULE 64/bin/go bash t-ha�� ithub/workflows/agent-persona-explorer.md go 1/x64/bin/node -json GO111MODULE 64/bin/go git-upload-pack(http block)https://api.github.com/repos/github/gh-aw-actions/git/ref/tags/v1.2.3/usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v1.2.3 --jq .object.sha 5821-30459/test-3343007444 go /home/REDACTED/.cargo/bin/bash ignore-path ../.git GO111MODULE 64/bin/go bash --no�� --noprofile go /usr/bin/git -json GO111MODULE 64/bin/go git(http block)https://api.github.com/repos/github/gh-aw/actions/runs/1/artifacts/usr/bin/gh gh run download 1 --dir test-logs/run-1 GO111MODULE p/bin/bash GOINSECURE GOMOD(http block)https://api.github.com/repos/github/gh-aw/actions/runs/12345/artifacts/usr/bin/gh gh run download 12345 --dir test-logs/run-12345 GO111MODULE /opt/hostedtoolcache/go/1.25.0/x--quiet GOINSECURE GOMOD GOMODCACHE go env |Timeout.*second\|seconds.*timeout k/gh-aw/gh-aw/pkg/cli/ sh ignore GOMOD GOMODCACHE go(http block)https://api.github.com/repos/github/gh-aw/actions/runs/12346/artifacts/usr/bin/gh gh run download 12346 --dir test-logs/run-12346 GO111MODULE /opt/hostedtoolc-lang=go1.25 GOINSECURE GOMOD GOMODCACHE go env fully" GO111MODULE 86_64/bash ignore GOMOD GOMODCACHE go(http block)https://api.github.com/repos/github/gh-aw/actions/runs/2/artifacts/usr/bin/gh gh run download 2 --dir test-logs/run-2 GO111MODULE cal/bin/bash GOINSECURE GOMOD GOMODCACHE R9/-4LzASpRV2zK6test@example.com env .version=37648ce-dirty" -o gh-aw ./cmd/gh-aw GO111MODULE ndor/bin/bash GOINSECURE GOMOD GOMODCACHE go(http block)https://api.github.com/repos/github/gh-aw/actions/runs/3/artifacts/usr/bin/gh gh run download 3 --dir test-logs/run-3 GO111MODULE 64/bin/go GOINSECURE GOMOD GOMODCACHE go env 4017834897/.github/workflows rty k/node_modules/.bin/node GOINSECURE GOMOD GOMODCACHE go(http block)https://api.github.com/repos/github/gh-aw/actions/runs/4/artifacts/usr/bin/gh gh run download 4 --dir test-logs/run-4 GO111MODULE nfig/composer/vendor/bin/bash GOINSECURE GOMOD GOMODCACHE go env -json GO111MODULE es/.bin/node GOINSECURE GOMOD GOMODCACHE go(http block)https://api.github.com/repos/github/gh-aw/actions/runs/5/artifacts/usr/bin/gh gh run download 5 --dir test-logs/run-5 GO111MODULE rgo/bin/bash GOINSECURE GOMOD GOMODCACHE ks/uHvMf0NAnOjab896TNzs/AXMwmaH9config env md GO111MODULE e_modules/.bin/node GOINSECURE GOMOD GOMODCACHE go(http block)https://api.github.com/repos/github/gh-aw/actions/workflows/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 GOMOD GOMODCACHE ache/go/1.25.0/xGO111MODULE env 3957768/b402/_pkGOINSECURE GO111MODULE 64/bin/go GOINSECURE GOMOD GOMODCACHE go(http block)/usr/bin/gh gh run list --json databaseId,number,url,status,conclusion,workflowName,createdAt,startedAt,updatedAt,event,headBranch,headSha,displayTitle --workflow nonexistent-workflow-test-12345 --limit 6 GOMOD GOMODCACHE ache/go/1.25.0/xGO111MODULE env 3957768/b407/_pkGOINSECURE GO111MODULE 64/bin/go GOINSECURE GOMOD GOMODCACHE go(http block)/usr/bin/gh gh run list --json databaseId,number,url,status,conclusion,workflowName,createdAt,startedAt,updatedAt,event,headBranch,headSha,displayTitle --workflow nonexistent-workflow-ci-test-67890 --limit 6 GOMOD GOMODCACHE ache/go/1.25.0/xGO111MODULE env 3957768/b418/_pkGOINSECURE GO111MODULE 64/bin/go GOINSECURE GOMOD GOMODCACHE go(http block)https://api.github.com/repos/github/gh-aw/git/ref/tags/v0.47.4/usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v0.47.4 --jq .object.sha --show-toplevel ache/go/1.25.0/x--auto /usr/bin/git *.json' '!../../git GO111MODULE k/_temp/ghcca-no--show-toplevel git rev-�� --show-toplevel go /usr/bin/git rity2952619322/0git GO111MODULE k/node_modules/.--verify git(http block)https://api.github.com/repos/github/gh-aw/git/ref/tags/v1.0.0/usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v1.0.0 --jq .object.sha ty-test.md GO111MODULE nfig/composer/vendor/bin/bash GOINSECURE b/gh-aw/pkg/cli GOMODCACHE go env 24436360.go GO111MODULE 64/pkg/tool/linux_amd64/cgo GOINSECURE GOMOD GOMODCACHE 64/pkg/tool/linux_amd64/cgo(http block)https://api.github.com/repos/github/gh-aw/git/ref/tags/v1.2.3/usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v1.2.3 --jq .object.sha -json GO111MODULE ache/go/1.25.0/x64/bin/go GOINSECURE GOMOD GOMODCACHE go env th .prettierignore --log-level=e!../../../pkg/workflow/js/**/*.json GO111MODULE ache/go/1.25.0/x64/bin/go GOINSECURE GOMOD GOMODCACHE rO4MKBK/F_RuzlMTzL9ZnhY2x-TC(http block)https://api.github.com/repos/github/gh-aw/git/ref/tags/v2.0.0/usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v2.0.0 --jq .object.sha -json GO111MODULE odules/npm/node_modules/@npmcli/run-script/lib/node-gyp-bin/sh GOINSECURE GOMOD GOMODCACHE go env th .prettierignore --log-level=e!../../../pkg/workflow/js/**/*.json GO111MODULE ode_modules/.bin/prettier GOINSECURE GOMOD GOMODCACHE eDXfSXk/Kh5wiGQgconfig(http block)/usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v2.0.0 --jq .object.sha json' --ignore-path ../../../.pr**/*.json GO111MODULE .test GOINSECURE GOMOD GOMODCACHE .test 3696�� th .prettierignore --log-level=error GO111MODULE estTimeout|TestLogs GOINSECURE GOMOD GOMODCACHE go(http block)/usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v2.0.0 --jq .object.sha json' --ignore-p-p GO111MODULE ache/go/1.25.0/x-lang=go1.25 GOINSECURE GOMOD GOMODCACHE go ules�� -json GO111MODULE ache/go/1.25.0/x-test.short=true GOINSECURE GOMOD GOMODCACHE go(http block)https://api.github.com/repos/github/gh-aw/git/ref/tags/v3.0.0/usr/bin/gh gh api /repos/github/gh-aw/git/ref/tags/v3.0.0 --jq .object.sha json' --ignore-path ../../../.pr**/*.json GO111MODULE 64/pkg/tool/linux_amd64/compile GOINSECURE GOMOD GOMODCACHE 64/pkg/tool/linuorigin env th .prettierignore --log-level=error GO111MODULE 1/x64/bin/bash GOINSECURE GOMOD GOMODCACHE go(http block)https://api.github.com/repos/nonexistent/action/git/ref/tags/v999.999.999/usr/bin/gh gh api /repos/nonexistent/action/git/ref/tags/v999.999.999 --jq .object.sha *.json' '!../../.github/workflows/test.md GO111MODULE 64/bin/bash GOINSECURE GOMOD GOMODCACHE go env b/workflows GO111MODULE 64/pkg/tool/linux_amd64/vet GOINSECURE GOMOD GOMODCACHE 64/pkg/tool/linux_amd64/vet(http block)https://api.github.com/repos/nonexistent/repo/actions/runs/12345/usr/bin/gh gh run view 12345 --repo nonexistent/repo --json status,conclusion GOINSECURE GOMOD GOMODCACHE go env y_only_defaults_repo427241839/001 GO111MODULE 1/x64/bin/bash nore GOMOD GOMODCACHE go(http block)https://api.github.com/repos/owner/repo/actions/workflows/usr/bin/gh gh workflow list --json name,state,path --repo owner/repo 64/bin/go GOINSECURE GOMOD GOMODCACHE go env -json GO111MODULE odules/npm/node_modules/@npmcli/run-script/lib/node-gyp-bin/sh GOINSECURE GOMOD GOMODCACHE go(http block)/usr/bin/gh gh workflow list --json name,state,path --repo owner/repo 64/bin/go GOINSECURE GOMOD GOMODCACHE go env -json GO111MODULE 64/bin/go GOINSECURE GOMOD GOMODCACHE go(http block)https://api.github.com/repos/owner/repo/contents/file.md/tmp/go-build1366437912/b396/cli.test /tmp/go-build1366437912/b396/cli.test -test.testlogfile=/tmp/go-build1366437912/b396/testlog.txt -test.paniconexit0 -test.v=true -test.parallel=4 -test.timeout=10m0s -test.run=^Test -test.short=true GOINSECURE GOMOD GOMODCACHE go tlog�� w/js/**/*.json' --ignore-path GO111MODULE 64/bin/go GOINSECURE GOMOD GOMODCACHE go(http block)https://api.github.com/repos/test-owner/test-repo/actions/secrets/usr/bin/gh gh api /repos/test-owner/test-repo/actions/secrets --jq .secrets[].name go1.25.0 -c=4 -nolocalimports -importcfg /tmp/go-build1366437912/b405/importcfg -pack /tmp/go-build1366437912/b405/_testmain.go env -json GO111MODULE 64/bin/go GOINSECURE GOMOD GOMODCACHE go(http block)If you need me to access, download, or install something from one of these locations, you can either: