Skip to Content
Log inTry Agor Cloud
DocsGetting Started

Getting Started

Install Agor Community Edition, 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 ) and Git on PATH. HTTPS remotes also require a working system CA trust store; SSH remotes require an SSH client and configured keys or agent access. Run git --version before agor init.

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

Run agor init after installation. It shows a multi-select for every supported agentic tool and requires an intentional selection of at least one. The prompt explains that each selection adds download time and disk use; credentials are configured later in the UI. Init writes the selection once to agentic_tools.installed and installs the exact version-aligned packages before reporting success. Press Ctrl+C to cancel. An intentionally tool-free headless deployment must use --agentic-tools none.

To change the deployment policy later, edit agentic_tools.installed in config.yaml, run agor install --sync, and restart the daemon. Agor does not silently rewrite existing config. Repeat the readiness check with agor doctor; see Agentic tools for the complete model.

Follow the onboarding wizard

The first time a member opens the UI, the Onboarding Wizard runs — four quick steps that end on a new board. Read-only viewers enter the workspace directly because their role cannot provision boards, repos, branches, or sessions.

  1. Teammate. Name your AI teammate and pick a starting point (both are needed to continue): templates give a head start, Start from scratch gives a blank teammate, or skip this step to create a plain board without a teammate.
  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. You can also skip and connect one later.
  3. Tools. Browse the whole MCP Catalog, with search and a category filter. Tools that fit the starting point you picked are listed first; nothing is hidden or preselected. Click the tools you use to pick them (click again to unpick). Onboarding doesn’t connect anything: your teammate’s first session helps you connect the tools you picked.
  4. You’re ready. Agor creates the board. If you named a teammate, it seeds that teammate from the framework repo  and, when an AI model is connected, launches the first session.

Teammate setup, AI, and tools are optional; the final action always creates or resumes one board. If setup is interrupted after that board is created, reopening the wizard resumes the same board instead of creating another.

Agor prepares the teammate repository in the background while you fill in the wizard. This optional prefetch does not show global error notifications. If you named a teammate, finishing setup requires its repository and teammate workspace to be ready, even when no agent is available to start a session: a failure stays in the wizard with an actionable message and Try again, rather than marking onboarding complete. Retries reuse the same repository and preserve its name, saved environment configuration, and existing branches. Automatic .agor.yml import is only attempted on an administrator’s initial registration; after recovery, use the explicit import action if needed. Repository setup status and credential-redacted diagnostics remain available to administrators; never delete a repository or its branches just to retry onboarding. A pending setup is not automatically restarted on a timer because a slow worker may still be running.

You can press Escape or the X on any step, including the final step and after an error, to close onboarding and finish later. This records a deferral, not a successful completion, and does not provision anything by itself. Continue from Settings → Profile → Resume onboarding; Resume preserves saved progress, while Restart intentionally starts the wizard over. A failed final action keeps the saved board/progress available for a retry rather than creating another board. If setup takes longer than expected, Agor keeps that one attempt in flight instead of starting a duplicate; you can still close and finish later.

When the board opens, a connected teammate’s first session picks up where the wizard left off — it already knows its name, the starting point you picked, and the tools you want help connecting. Connecting goes through the same Catalog consent, permission, readiness, and connection services as the rest of Agor. GitHub MCP uses its reviewed Catalog entry and a fine-grained personal access token entered in the secure drawer; connecting a repository does not authenticate GitHub MCP. Never paste a PAT into chat. Workspace MCP policy may require an administrator to allow installation.

Onboarding doesn’t set up Slack. A Slack gateway lets you message a teammate through a bot; ask your teammate to help you set one up later. It rechecks permissions and inventory, collects non-secret choices, creates one disabled draft, then uses the secure gateway credential widget and verifies it before enabling.

Slack MCP gives an agent Slack tool access; gateway messaging does not grant it. Slack is not currently in Catalog: official Slack MCP  requires a registered internal or approved OAuth app and does not support dynamic client registration. Agor has no reviewed public OAuth client for this entry. Slack MCP is not selected or recommended as a connection alongside the gateway. An already configured, approved Slack MCP server can be managed through existing MCP settings. Never reuse gateway bot/app tokens as MCP credentials. From there the teammate can register repos, organize its board, structure a workflow, or just be a thinking partner. It works through the same API you do, via the Agor MCP Server. If you skipped AI setup, connect a model later from Settings → AI & Agents and start a session from the board.

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
  • Execution isolation with fail-closed local sandboxing or a reviewed delegated substrate
  • 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 TeammateFeature Map