Quickstart

Requirements#

  • Docker, running locally
  • Bun 1.3+

Try it locally#

git clone https://github.com/croffasia/itsaplan.git
cd itsaplan
bun install
bun run setup   # answer "Try it"

bun run setup picks free ports, generates the secrets, starts the whole stack in Docker (Postgres, RustFS, api, worker, bot, web), and opens http://localhost:3001. Everything runs on localhost, so no domain and no reverse proxy are needed.

Run bun run setup again later to restart the instance; the data stays.

Create your account#

The first account you register becomes the instance admin. From there you can create a project, add a board, and invite teammates.

Turn on an AI agent#

  1. Open your project's Settings → AI agents and create an agent.
    • An internal agent runs on the instance: pick a model, write a system prompt, and attach tools or skills.
    • An external agent runs on your own machine through @itsaplan/runner, driven by a coding agent CLI you already use (Claude Code, Codex, and others).
  2. Enable MCP Server under the project's Settings — it's off by default.
  3. Assign an issue to the agent, or @mention it in a comment. The run starts from there.

Next steps#

  • Deploying for a team instead of trying it locally? See Installation.
  • Want to understand projects, issues, cycles, and views? Read Core concepts.
  • Setting up an external agent with Claude Code or Codex? See Coding agent setup.

Updated

Was this page helpful?