Skip to content

docs: sync gh aw init documentation with current implementation#16465

Closed
Copilot wants to merge 2 commits intomainfrom
copilot/update-gh-aw-init-docs
Closed

docs: sync gh aw init documentation with current implementation#16465
Copilot wants to merge 2 commits intomainfrom
copilot/update-gh-aw-init-docs

Conversation

Copy link
Contributor

Copilot AI commented Feb 17, 2026

The gh aw init command 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 implementation

Added missing documentation:

  • --create-pull-request flag and usage example
  • -v verbose flag example

Updated description:

  • Changed "logs .gitignore" to "VSCode settings" to reflect actual behavior
# Before (documented but non-functional)
gh aw init --engine copilot
gh aw init --tokens --engine copilot

# After (matches current implementation)
gh aw init -v
gh aw init --create-pull-request

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/user
    • Triggering command: /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)
    • Triggering command: /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)
    • Triggering command: /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
    • Triggering command: /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.

Copilot stopped work on behalf of pelikhan due to an error February 17, 2026 23:33
Copilot stopped work on behalf of pelikhan due to an error February 17, 2026 23:33
Copilot stopped work on behalf of pelikhan due to an error February 17, 2026 23:33
- 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>
Copilot AI changed the title [WIP] Update gh aw init documentation for latest changes docs: sync gh aw init documentation with current implementation Feb 17, 2026
Copilot AI requested a review from pelikhan February 17, 2026 23:38
@pelikhan pelikhan marked this pull request as ready for review February 17, 2026 23:40
Copilot AI review requested due to automatic review settings February 17, 2026 23:40
@pelikhan
Copy link
Contributor

@copilot add --engine and --copilot back as hidden flag (with message that they are deprecated)

Copy link
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

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 init flags (--engine, --tokens) and documents --create-pull-request plus a verbose (-v) example.
  • Updates the init description 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.

Comment on lines +120 to +124
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
Copy link

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

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

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

Copilot uses AI. Check for mistakes.
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.

3 participants