Skip to Content
DocsGetting Started

Getting Started

Install Agor, open the UI, and follow the onboarding wizard. Your first AI teammate will help you get your bearings and get everything else set up. (New here? Raising Your First AI Teammate explains why one teammate is the whole onboarding.)

Install

Most users should start here. It’s the most universal path, and it’s the one the rest of the docs assume.

Requires Node.js ≥ 22.12 (install ).

# Install Agor
npm install -g agor-live
 
# First run
agor init
agor daemon start
agor open

Run agor init after installation. It lets you choose the agentic tools you plan to use and shows exactly what will be installed before running npm. Skip the selection if you are not ready—you can add a version-aligned tool later by editing agentic_tools.installed in config.yaml and running agor install. Repeat the readiness check with agor doctor; see Agentic tools for the complete model.

Follow the onboarding wizard

The first time you open the UI, the Onboarding Wizard runs — five quick steps that end with your first AI teammate ready to work:

  1. You. Pick how you work: I write code, I manage projects, I lead a team, or Building solo. The rest of the setup — and your teammate’s first briefing — is tailored to this.
  2. AI. Connect a model: Claude (recommended), GPT, Gemini, or a custom endpoint. Paste an API key, use a Claude subscription token, or sign in with ChatGPT; Agor verifies the credential on the spot.
  3. Workspace. Name your AI teammate and pick its emoji. Agor creates a board named after it — the teammate’s home for every branch and session it works on.
  4. Tools. Persona-tailored MCP integration suggestions (Slack first, plus the likes of GitHub, Sentry, HubSpot, Linear, or Figma). Connect what you want now, or skip — everything is available later in Settings → MCP.
  5. You’re ready. Agor seeds the teammate from the framework repo  onto your new board and launches its first session with the agent you connected.

Every step except the last can be skipped — the wizard never blocks you on a decision.

Onboarding step 1: persona cards — I write code, I manage projects, I lead a team, Building soloOnboarding step 2: Connect your AI — Claude selected (Recommended) with API key and Subscription token tabs; GPT and Gemini belowOnboarding step 3: Name your AI teammate — name and emoji, with its own boardOnboarding step 4: Connect your tools via MCP — persona-tailored suggestions like Slack, HubSpot, Amplitude, Figma

When the board opens, your teammate’s first session picks up where the wizard left off — it already knows its name, how you work, and which tools you flagged. From there it can register repos, organize its board, structure a workflow, or just be a thinking partner. Anything a user can do in Agor, the teammate can do too. It has full access to the Agor MCP Server.

Customize your install

Agor runs out of the box on SQLite as a single-user instance, but it’s designed to scale up:

  • PostgreSQL backend instead of SQLite, for multi-user / team setups
  • Multiplayer mode with branch-level RBAC and per-user permissions
  • Unix-user impersonation so each Agor user’s sessions run as their own OS identity
  • Docker Compose and source builds for contributor / dev workflows — see the Docker Compose tab above for the evaluation quickstart
  • Custom config / database paths for non-default install layouts

For any of those, see Extended Installation. For credential alternatives (claude setup-token, codex login --device-auth, workspace-wide env vars), see Authentication.

What’s next

Get help

Last updated on
Your First AI TeammateExtended Installation