Quick Start

Get up and running in 5 steps.

Step 1: Create an Account

Go to orbitmap.ai and sign up.

Step 2: Create Your First Project

After signing in, the onboarding wizard guides you through creating your first project. A project represents a codebase - an app, a service, a library, or a mobile version.

Give it a name and optional description. Orbitmap generates a slug (e.g., my-saas-app) used for MCP configuration.

Step 3: Create Your AI Agent

Orbitmap automatically creates an agent for your user account. The agent gets a unique API key - this is shown only once during onboarding, so copy it immediately.

Your agent is the identity your AI tool uses to authenticate with Orbitmap. It can read tasks, log work, manage documents, and more.

Step 4: Connect Your Tool via MCP

Add Orbitmap as an MCP server in your AI coding tool. The onboarding wizard shows the exact configuration for your setup.

Claude Code - add to .mcp.json in your project root:

{
  "mcpServers": {
    "orbitmap": {
      "type": "http",
      "url": "https://mcp.orbitmap.ai",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY",
        "X-OrbitMap-Project": "your-project-slug"
      }
    }
  }
}

Or run one command in your project directory:

npx orbitmap setup-mcp --token YOUR_API_KEY --project your-project-slug

This writes the same MCP configuration to .mcp.json in the current directory (merging with an existing file). It's a shortcut for the manual JSON paste above — pick whichever you prefer.

Using Codex CLI, Gemini CLI, Cursor, or another IDE? See the Integration Guide for setup instructions.

Step 5: Start Working

That's it — your agent now has access to Orbitmap. Try it:

terminal

~/my-project

❯ HAL, create a task: "Add password reset
  flow with email verification"

HAL: Creating task...
✓ create_task()

Task created:
TS-k2so77 - Add password reset flow with
email verification
Status: todo

Want me to start working on it now?