Skip to content

docs: document missing init command flags (--tokens, --engine, --codespaces, --campaign, --completions)#9954

Merged
pelikhan merged 2 commits intomainfrom
copilot/add-init-command-flag-docs
Jan 14, 2026
Merged

docs: document missing init command flags (--tokens, --engine, --codespaces, --campaign, --completions)#9954
pelikhan merged 2 commits intomainfrom
copilot/add-init-command-flag-docs

Conversation

Copy link
Contributor

Copilot AI commented Jan 14, 2026

The gh aw init command documentation only mentioned --no-mcp, omitting 5 other flags available in the implementation.

Changes

Updated docs/src/content/docs/setup/cli.md to document all init flags:

  • --tokens - Validate secret configuration for agentic workflows
  • --engine (copilot, claude, codex) - Specify engine when checking tokens (requires --tokens)
  • --codespaces - Configure devcontainer.json with gh-aw permissions (optional: comma-separated repo names)
  • --campaign - Install Campaign Designer agent
  • --completions - Install shell completions for detected shell

Added usage examples and Options section matching other command documentation patterns.

Screenshot

init command documentation

Documentation now shows all 7 init command options with practical examples.

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:

  • telemetry.astro.build
    • Triggering command: /opt/hostedtoolcache/node/24.12.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)
    • Triggering command: /opt/hostedtoolcache/node/24.12.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro dev (dns block)

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

Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] Missing documentation for init command flags (--tokens, --codespaces, --campaign, --completions)</issue_title>
<issue_description>## Issue Description

Command: gh aw init
Type: Documentation omission - missing flags
Priority: Medium

Current Documentation (cli.md line 116-121)

Initialize repository for agentic workflows. Configures `.gitattributes`, Copilot instructions, prompt files, and logs `.gitignore`. Enables MCP server integration by default (use `--no-mcp` to skip).

```bash wrap
gh aw init         # With MCP integration (default)
gh aw init --no-mcp # Skip MCP server integration

### Issue

The documentation only mentions `--no-mcp` flag, but examining `/home/runner/work/gh-aw/gh-aw/pkg/cli/init_command.go` (lines 40-76) reveals several important flags that are NOT documented:

**Missing flags:**
1. `--tokens` - Validates which required and optional secrets are configured
2. `--engine` - Check engine-specific tokens (copilot, claude, codex) - used with --tokens
3. `--codespaces` - Updates/creates .devcontainer/devcontainer.json with proper permissions
4. `--campaign` - Creates campaign dispatcher agent
5. `--completions` - Automatically installs shell completion

### Expected Documentation

The documentation should list all available flags with examples:

```markdown
#### `init`

Initialize repository for agentic workflows. Configures `.gitattributes`, Copilot instructions, prompt files, and logs `.gitignore`. Enables MCP server integration by default (use `--no-mcp` to skip).

```bash wrap
gh aw init                              # With MCP integration (default)
gh aw init --no-mcp                     # Skip MCP server integration  
gh aw init --tokens --engine copilot    # Check Copilot token configuration
gh aw init --codespaces                 # Configure devcontainer for current repo
gh aw init --codespaces repo1,repo2     # Configure devcontainer for additional repos
gh aw init --campaign                   # Enable campaign functionality
gh aw init --completions                # Install shell completions

Options: --no-mcp, --tokens, --engine (copilot, claude, codex), --codespaces, --campaign, --completions


### Impact

Users are unaware of powerful initialization options like:
- Token validation (`--tokens --engine copilot`)
- Codespaces configuration (`--codespaces`)
- Shell completion installation (`--completions`)
- Campaign setup (`--campaign`)

This is particularly problematic for `--tokens` which provides critical secret validation feedback.




> AI generated by [CLI Consistency Checker](https://github.com/githubnext/gh-aw/actions/runs/20995531382)

<!-- agentic-workflow: CLI Consistency Checker, engine: copilot, run: https://github.com/githubnext/gh-aw/actions/runs/20995531382 --></issue_description>

## Comments on the Issue (you are @copilot in this section)

<comments>
</comments>


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Added documentation for --tokens, --engine, --codespaces, --campaign, and --completions flags that were missing from the init command section in cli.md

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for init command flags docs: document missing init command flags (--tokens, --engine, --codespaces, --campaign, --completions) Jan 14, 2026
Copilot AI requested a review from mnkiefer January 14, 2026 14:10
@pelikhan pelikhan marked this pull request as ready for review January 14, 2026 14:19
@pelikhan pelikhan merged commit efad162 into main Jan 14, 2026
@pelikhan pelikhan deleted the copilot/add-init-command-flag-docs branch January 14, 2026 14:21
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] Missing documentation for init command flags (--tokens, --codespaces, --campaign, --completions)

3 participants