Installation

Requirements

• Node.js 24.2 or newer
• aube, the package manager pinned in package.json
• Git

Both Node.js and aube are pinned in mise.toml, so mise can install them together.

Set up a local environment

git clone https://github.com/wolfstar-project/agent-zero.git
cd agent-zero
mise install            # or: npm install -g --ignore-scripts=false @endevco/aube
aube ci
cp .env.example .env
cp apps/dashboard/.env.example apps/dashboard/.env
aube test

aube run <script> and aube test check install freshness first, so a separate install step is rarely needed. aube reads and writes the existing pnpm-lock.yaml and pnpm-workspace.yaml in place — the lockfile stays in pnpm's v9 format.

The root .env belongs to the CLI. Runnable apps keep their configuration beside the app: apps/dashboard/.env for the dashboard and optional apps/docs/.env for the documentation site.

First run

Inspect the local environment, then run a review:

aube run zero doctor
aube run zero review --feedback "Possible null dereference in src/user.ts"
aube run zero review --proactive

review inspects without editing; it is safe on any checkout. See the CLI reference for every command and flag.

Start the dashboard

aube run dev

The single deployable app starts on http://localhost:3000 (override with PORT). It serves the UI, the typed control plane at /rpc/**, the OpenAPI surface at /api/v1/** (interactive docs at /api/v1/docs), and authentication at /api/auth/**. The dashboard's sign-in requires a Postgres database — see Database and Authentication.

Configure a repository

Create a repository policy in the repository Agent Zero should work on:

zero init

This writes .agent-zero.yml with the safe defaults: mode: observe, proactive review disabled, autofix disabled. Every key is documented in Repository policy.

Next steps

• Environment variables — model credentials, control-plane tokens, auth, and mail.
• Codebase structure — where everything lives.
• Deployment — running the dashboard in production.