Align CLI reference with current gh aw --help output#44603
Merged
pelikhan merged 2 commits intoJul 10, 2026
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix CLI completion subcommand description
Align CLI reference with current Jul 9, 2026
gh aw --help output
Contributor
|
PR Triage - Run 29041860272. Category: docs | Risk: Low | Score: 40/100 | Action: defer | Batch: docs-updates. DRAFT. CLI reference alignment with current gh aw --help (22+/5-, 1 file). Pure doc fix, batch with other doc PRs. Undraft to merge.
|
Contributor
🤖 PR Triage — Run §29061171191
CLI reference alignment with current gh aw --help. DRAFT, 1 file, 22 additions. Low risk docs update. Batch with other docs PRs.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates the CLI setup documentation to reflect newer gh aw command capabilities and clarify defaults/flags across several subcommands.
Changes:
- Add examples for adding local workflow template files via
gh aw add - Clarify behaviors/defaults for
new,logs, andaudit - Expand MCP (
mcp inspect/mcp add) usage examples and document related options
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/setup/cli.md | Updates CLI examples and docs for local workflow inputs, command defaults, MCP usage, and completion argument syntax |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 4
- Review effort level: Low
Comment on lines
+180
to
+181
| gh aw add ./my-workflow.md # Add a local workflow file | ||
| gh aw add ./*.md # Add multiple local workflow files |
Comment on lines
+795
to
+798
| gh aw mcp add workflow server # Add an MCP server to a workflow | ||
| gh aw mcp add workflow server --transport stdio # Prefer stdio transport | ||
| gh aw mcp add workflow server --registry https://custom.registry.com/v1 # Use custom registry | ||
| gh aw mcp add workflow server --tool-id my-server # Override the tool ID |
|
|
||
| **Options:** `--after-run-id`, `--artifacts`, `--before-run-id`, `--cache-before`, `--count/-c`, `--end-date`, `--engine`, `--filtered-integrity`, `--firewall`, `--format`, `--json/-j`, `--last`, `--no-firewall`, `--no-staged`, `--output/-o`, `--parse`, `--ref`, `--report-file`, `--repo/-r`, `--safe-output`, `--start-date`, `--stdin`, `--summary-file`, `--timeout`, `--tool-graph`, `--train` | ||
|
|
||
| `logs` defaults `--artifacts` to `usage` for faster, compact downloads. The `--last` flag is an alias for `--count/-c`. |
| ``` | ||
|
|
||
| **Subcommands:** `install`, `uninstall`, `bash`, `zsh`, `fish`, `powershell`. See [Shell Completions](#shell-completions). | ||
| **Shell arguments:** `bash`, `zsh`, `fish`, `powershell` — **Subcommands:** `install`, `uninstall`. See [Shell Completions](#shell-completions). |
Contributor
|
🎉 This pull request is included in a new release. Release: |
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.
The CLI reference had drifted from the live
gh aw --helpsurface in several places, including incorrect command structure, missing flags, and examples that no longer matched actual usage. This updates the docs to reflect the current CLI behavior without changing the CLI itself.Correct command structure
gh aw completionaccepts shell names as positional arguments (bash,zsh,fish,powershell), while onlyinstallanduninstallare true subcommands.gh aw newto describe the actual behavior: template creation with interactive wizard fallback, without claiming editor auto-open.Fill missing CLI reference details
gh aw mcp inspectflags:--check-secrets,--inspector,--server,--tool.gh aw mcp addflags:--transport,--registry,--tool-id.--repo/-rshorthand forgh aw secrets set.Bring examples back in sync
mcp addexamples to use the actual optional-argument form shown by the CLI.mcp inspectexamples for server filtering, tool inspection, inspector launch, and secret checks.gh aw addexamples and the missinggh aw experiments analyze --jsonexample.Clarify
logsvsauditdefaultslogsdefaults tousage, whileauditdefaults toall.--lastonlogsis an alias for--count/-c.Example of the corrected
completiondescription: