Quickstart — running in 5 minutes

Self-hosted, single operator, your own Anthropic key. No SaaS account, no lock-in.

Prerequisites

The five steps

# 0. Preflight — a root-owned npm prefix (common with Homebrew/OS-bundled Node)
#    fails the next line with a raw EACCES. Check + redirect to ~/.local if needed:
p="$(npm config get prefix)"; [ -w "$p" ] || { npm config set prefix "$HOME/.local"; export PATH="$HOME/.local/bin:$PATH"; }

# 1. Install the CLI (one binary: `myai`, aliased `ai-manage`)
npm i -g ai-management

# 2. Preflight — checks docker, node, compose, ports, your key
myai doctor

# 3. Initialize the framework into a repo (this one, or any path).
#    The guided wizard asks 3 things: API key · profile · scan dir.
#    It writes them to AI/.env. Press Enter to skip any answer.
myai init .

# 4. Bring the self-contained stack up (gateway + dashboard + mongo).
#    Waits for health, then prints the dashboard URL.
myai up
#    → Dashboard   http://localhost:3210
#    → Gateway MCP http://localhost:3100/mcp

# 5. Register the repos you want to manage (RAG + directory)
myai scan ~/code --register

Open http://localhost:3210/welcome — the page greets you with the local quickstart and one-tap links into the running dashboard.

Then try

# Plug ANY agent into your brain — one front door. `myai plug` lists every
# supported agent; name one and it boots knowing you. Prove it with no agent
# installed first:
myai plug proof                    # live continuity round-trip against the gateway
myai plug claude                   # MCP clients: cursor | windsurf | codex | gemini | opencode
myai plug ollama                   # blank/local agents: ollama | chatgpt | print

# Queue an autonomous task — the off-hours runner builds it and surfaces
# it in Needs Review on the dashboard
myai schedule --title "Add dark mode to the settings page"

# Seed realistic sample data so the first-run dashboard is alive
myai demo

# Generate a brand-new full-stack app from one sentence
myai new-app ~/code/my-idea

Credentials

Bring-your-own. Set ANTHROPIC_API_KEY during myai init (or any time in AI/.env), or skip it and let the runner use your logged-in Claude CLI. No keys ship in the package.

Everyday operations

myai status          # stack health + task-queue counts (--json for scripts)
myai logs gateway    # tail one service (or all): gateway | dashboard | mongo
myai down            # stop cleanly (--volumes also drops the mongo data)

Non-interactive scaffold for CI/scripts: myai init <path> --no-wizard.

Next: read the Concepts page to understand what the stack is doing for you, or jump to the CLI reference.