Skip to content
AgentStack

Getting Started

AgentStack is easiest to adopt if you think in this order:

  1. get a profile
  2. activate it in the local hub
  3. run doctor
  4. materialize the provider you want to use

Prerequisites

Section titled “Prerequisites”
  • Node.js >= 18
  • pnpm or npm
  • At least one supported provider installed separately: Codex, Claude Code, OpenCode, or Gemini CLI

Install AgentStack

Section titled “Install AgentStack”
Install AgentStack globally
npm install -g agentstack
# or
pnpm add -g agentstack

Verify:

Terminal window
agentstack --version

Path A — Install a shared profile

Section titled “Path A — Install a shared profile”

If your team already has a shared profile repository or template:

Install a shared profile template
agentstack profile install \
  url:https://github.com/acme/agentstack-profiles \
  --profile mobile-default

Then activate it:

Activate the profile
agentstack profile activate mobile-default

If you come through agentstack init, AgentStack now activates the resulting profile for you automatically.

Path B — Bootstrap from your current setup

Section titled “Path B — Bootstrap from your current setup”

If you already use one tool and want to bring that setup into AgentStack:

Interactive init
agentstack init --profile main

Or import directly:

Import from Codex
agentstack import \
  --from codex \
  --source ~/.codex/config.toml \
  --profile-file ~/.agentstack/profiles/main/agentstack.yaml

Run doctor

Section titled “Run doctor”
Validate the active profile
agentstack doctor \
  --profile-file ~/.agentstack/profiles/mobile-default/agentstack.yaml

Doctor validates the canonical schema and also checks the current hub/runtime state.

Materialize a provider config

Section titled “Materialize a provider config”

If you want to use Codex:

Apply to Codex
agentstack apply \
  --profile-file ~/.agentstack/profiles/mobile-default/agentstack.yaml \
  --to codex

If you want to use Claude Code:

Apply to Claude
agentstack apply \
  --profile-file ~/.agentstack/profiles/mobile-default/agentstack.yaml \
  --to claude

Next steps

Section titled “Next steps”