docs: sync gh aw init documentation with current implementation#16465
docs: sync gh aw init documentation with current implementation#16465
gh aw init documentation with current implementation#16465Conversation
- Remove outdated --engine and --tokens flags - Add missing --create-pull-request flag and example - Update description to mention VSCode settings instead of logs .gitignore - Add -v (verbose) example for consistency with command help - Simplify options list to match actual command flags Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
gh aw init documentation with current implementation
|
@copilot add --engine and --copilot back as hidden flag (with message that they are deprecated) |
There was a problem hiding this comment.
Pull request overview
Updates documentation to align with the current gh aw init CLI behavior and refreshes the “Agent Factory” workflow index so users aren’t guided toward removed/nonexistent flags.
Changes:
- Removes outdated
gh aw initflags (--engine,--tokens) and documents--create-pull-requestplus a verbose (-v) example. - Updates the
initdescription to reflect VSCode settings configuration. - Updates Agent Factory status entries (AI Moderator agent label and adds Contribution Check).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/src/content/docs/setup/cli.md | Syncs gh aw init docs with current flags/examples and updates description text. |
| docs/src/content/docs/agent-factory-status.mdx | Updates workflow listing metadata (AI Moderator agent label; adds Contribution Check). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Initialize repository for agentic workflows. Configures `.gitattributes`, Copilot instructions, prompt files, and VSCode settings. Enables MCP server integration by default (use `--no-mcp` to skip). Without arguments, enters interactive mode for engine selection and secret configuration. | ||
|
|
||
| ```bash wrap | ||
| gh aw init # Interactive mode: select engine and configure secrets | ||
| gh aw init --engine copilot # Non-interactive with specific engine | ||
| gh aw init -v # Interactive with verbose output |
There was a problem hiding this comment.
The init docs still claim that running gh aw init enters an interactive mode to select an engine and configure secrets, but the current implementation doesn’t prompt for engine selection (it unconditionally sets up Copilot-related files, MCP config, VSCode settings, etc.). Consider updating this sentence (and the example comment below) to reflect the actual behavior, and point users to gh aw secrets bootstrap --engine … for token/secret checks instead of implying init handles it interactively.
See below for a potential fix:
Initialize repository for agentic workflows. Configures `.gitattributes`, Copilot instructions, prompt files, and VSCode settings. Enables MCP server integration by default (use `--no-mcp` to skip). Without arguments, runs non-interactively with a default Copilot-focused configuration; to verify engine tokens and secrets, use `gh aw secrets bootstrap --engine <engine>`.
```bash wrap
gh aw init # Set up repo with default Copilot-focused configuration
gh aw init -v # Same as above with verbose output
The
gh aw initcommand documentation was out of sync with the actual implementation, listing non-existent flags and missing recently added features.Changes
Removed outdated flags:
--engine(copilot, claude, codex) - no longer exists in command--tokens- removed from implementationAdded missing documentation:
--create-pull-requestflag and usage example-vverbose flag exampleUpdated description:
.gitignore" to "VSCode settings" to reflect actual behaviorWarning
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/user/usr/bin/gh gh api user --jq .login -D GOAMD64_v1 -gensymabis -o /tmp/go-build3276675372/b147/symabis /opt/hostedtoolcache/go/1.25.0/x64/src/os/signal/sig.s(http block)/usr/bin/gh gh api user --jq .login -c=4 -nolocalimports -importcfg /tmp/go-build3276675372/b278/importcfg -pack /home/REDACTED/work/gh-aw/gh-aw/pkg/fileutil/fileutil.go(http block)/usr/bin/gh gh api user --jq .login -c=4 -nolocalimports -importcfg /tmp/go-build3276675372/b282/importcfg -pack /home/REDACTED/work/gh-aw/gh-aw/pkg/types/doc.go /home/REDACTED/work/gh-aw/gh-aw/pkg/types/mcp.go(http block)telemetry.astro.build/opt/hostedtoolcache/node/24.13.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.