Skip to main content

Setup Wizard

Run the interactive setup wizard to configure your Adjutant installation:

adjutant setup

Wizard steps​

The wizard walks through eight steps:

  1. Prerequisites — verifies dependencies are in place (Python, backend CLI, curl)
  2. Install path — confirms where Adjutant lives on disk
  3. Backend — choose between OpenCode and Claude Code CLI (see Backends)
  4. Identity — creates your soul.md, heart.md, and registry.md files (see Configuration)
  5. Messaging — prompts for your Telegram bot token and chat ID, writes them to .env
  6. Features — optional news briefing, screenshot, vision, search, and usage tracking
  7. Service — installs the shell alias and optionally sets up auto-start on boot
  8. Heartbeat — enables autonomous pulse/review schedule and sets notification budget

Backend selection​

During step 3, the wizard asks which LLM backend to use:

BackendBest for
OpenCodeVision support, model listing, session resume
Claude Code CLICost tracking, permission allowlists

You can switch backends later by editing adjutant.yaml — see Backends.

Repair mode​

If something needs fixing after initial setup, re-run in repair mode:

adjutant setup --repair

Repair mode runs health checks and offers to fix each issue found.

Dry-run mode​

Preview what the wizard would do without making changes:

adjutant setup --dry-run

Prompts run interactively as normal; filesystem writes, service installs, and crontab edits are suppressed and printed as [DRY RUN] Would: ... instead.

For implementation details, see Setup Wizard Internals.

Next step​

Send your first message to verify everything is working.