Agentic Install Runbook

Canonical zero-to-running setup path for agents and stewards

Agentic Install Runbook

Use this runbook when an agent or steward needs to take a machine or project from zero to a working AIWG session. The human-facing path is short: install AIWG, deploy the right artifacts, open the chosen agentic platform, and ask the steward to verify setup. Most AIWG CLI commands are tools for the agent to call inside the session, not commands the user has to learn.

Choose The Setup Scope

Use project-local setup for a repository, product, investigation, campaign, or research corpus. This is the default and keeps project context isolated.

Use global/user-scope setup when the user wants the same AIWG agent surface available across many workspaces. This is useful for personal defaults and for providers whose primary artifact location is under the user's home directory, but it can make unrelated projects share more context than expected.

If the user is unsure, choose project-local setup first.

Prerequisites

AIWG requires Node.js 20 or newer. New installs should use the current LTS Node line through a version manager such as `nvm`, especially on macOS.

node --version
npm --version

If Node or npm is missing, install them before continuing. On macOS, use the macOS Install Guide when npm global installs fail with `EACCES`.

Install AIWG

Install AIWG once for the user:

npm install -g aiwg
aiwg --version

If `aiwg` is not on `PATH`, use npm's global prefix to find the binary:

npm config get prefix
"$(npm config get prefix)/bin/aiwg" --version

In automation or fresh shells where PATH may be unreliable, use `npx`:

npx aiwg --version

Project-Local Setup

Run these commands from the project root:

cd /path/to/project
aiwg use sdlc --provider claude
aiwg status --probe --json
aiwg doctor

Replace the provider when the user is not using Claude Code:

aiwg use sdlc --provider codex
aiwg use sdlc --provider cursor
aiwg use sdlc --provider copilot
aiwg use sdlc --provider factory
aiwg use sdlc --provider opencode
aiwg use sdlc --provider warp
aiwg use sdlc --provider windsurf
aiwg use sdlc --provider hermes
aiwg use sdlc --provider openclaw

For guided setup, use the wizard instead of choosing the framework and provider manually:

cd /path/to/project
aiwg wizard --dry-run --goal "help me set up AIWG for this project"
aiwg wizard
aiwg status --probe --json

Global Or User-Scope Setup

Use user scope only when the user explicitly wants AIWG available across many workspaces or the provider guide recommends it:

aiwg use sdlc --provider claude --scope user
aiwg use sdlc --provider codex --scope user
aiwg use sdlc --provider warp --scope user
aiwg doctor --scope user

For non-interactive provisioning, target a project directory explicitly:

npx aiwg use sdlc --provider claude --prefix /path/to/project
npx aiwg doctor --prefix /path/to/project

Use the non-interactive guide for cloud-init, Docker, and CI examples: Non-Interactive Installation.

Provider Handoff

After deployment, open the chosen agentic platform in the project or workspace that was just configured. Then ask:

Check that AIWG is installed correctly and tell me what I can do here.
Read aiwg status --probe, report the engaged state, project root, provider
files, deployed frameworks, and one recommended next action.

Provider notes:

ProviderOpen after deployFirst check
Claude CodeRestart Claude Code in the project rootAsk the steward to verify AIWG status
CodexRestart Codex in the project rootAsk for AIWG status and one next action
CursorOpen the project in CursorAsk Cursor to verify AIWG is active
CopilotOpen the VS Code workspaceAsk Copilot Chat for AIWG status
FactoryStart Factory from the project rootAsk for the AIWG first action
OpenCodeOpen OpenCode in the project rootAsk for one AIWG route
WarpStart Warp in the project rootAsk the session to route through AIWG
WindsurfOpen the project in WindsurfAsk Cascade to verify AIWG status
HermesOpen a Hermes chat attached to the projectAsk for the AIWG route
OpenClawOpen OpenClaw with the workspaceAsk for one AIWG capability and verify deployment

Use `aiwg-regenerate` from inside the session when provider context files need to be rebuilt. Use `aiwg doctor` as the direct diagnostic escape hatch.

Verification

The local proof command is:

aiwg status --probe --json

The health check is:

aiwg doctor

Treat the status probe as the evidence for local deployment state. Provider sessions may still need a restart or reload before they read newly deployed files.

Common health-check outcomes:

SymptomWhat to do
`aiwg` not foundAdd npm's global `bin` directory to PATH or use `npx aiwg`
No provider artifactsRun `aiwg use sdlc --provider <provider>` from the project root
Wrong project root`cd` to the intended repository and rerun the setup
Stale provider sessionRestart or reload the agentic platform
Generated context is staleAsk the session to run `aiwg-regenerate`
Doctor reports repairable driftAsk the steward to explain the failing check and propose the smallest fix

What Not To Teach As The Default

Do not make normal users memorize `aiwg discover`, `aiwg show`, agent-loop commands, or framework-specific direct commands as the post-install path. Those remain available to agents and advanced operators, but the expected onboarding flow is platform-first and steward-first.