Skip to content

Docs · Quickstart

Get started with Project Orchestrator

Two ways to start: the desktop app, or the server on the command line with the engine you choose. Prerequisites explained, step by step.

Choose your path

I just want to use the app

Install the desktop app. A setup wizard guides you, so you do not type commands.

You need Docker Desktop and an AI to talk to: Claude Code with your own Claude account, or another model you connect. The AI is not included. Claude Code is the default and the most tried path; the other engines are alpha, and a model other than Claude Code needs sign-in turned on.

  1. Install Docker Desktop. The app can help you with this.
  2. Download the app for your system and open it. On an Intel Mac with macOS 10.15 to 13.3, take the older-macOS file: it has no local embeddings, so use an HTTP embedding provider such as Ollama.
  3. Follow the setup wizard. It checks Docker, can install Claude Code if you pick it, and starts the services. The first time takes a few minutes.

I am a developer

Install the server from the command line and connect your own tool, such as Claude Code, over MCP. The steps are below.

Install what you need, right here

Two things must be on your computer first. Pick your system, download or paste, check, and come back: you never have to leave this page to find an installer.

Docker Desktop

Runs the two services that hold the project memory (Neo4j and Meilisearch).

Open the downloaded .dmg, drag Docker into Applications, then open Docker once and wait for the whale icon to stop moving.

Or in a terminal

brew install --cask docker

Check that it works

Each line should print a version number. If you see « command not found », open a new terminal window and try again.

docker --versiondocker compose version

Docker must be running (open it once) before you start Project Orchestrator. Installation page of the publisher

Claude Code

The assistant Project Orchestrator works with. It uses your own Claude account.

Paste the command in a terminal. It installs everything it needs and asks for your password only if required.

Command

curl -fsSL https://claude.ai/install.sh | bash

Check that it works

Each line should print a version number. If you see « command not found », open a new terminal window and try again.

claude --version

Run claude once to sign in. Installation page of the publisher

Developer steps: command line

Before you start

Docker
Docker 20.10+ with Compose 2.0+, to run Neo4j and Meilisearch
An MCP client
Claude Code, Cursor, or an OpenAI agent
A project
A code repository, in one of the 17 supported languages
  1. 1.Install the orchestrator

    Homebrew installs orchestrator (the server), orch (a small command-line tool) and mcp_server (the bridge your tool starts). On Windows, or if you prefer an app, use the desktop app from the download section. On an Intel Mac older than macOS 13.4, the script picks the older-macOS build by itself (no local embeddings: use an HTTP embedding provider such as Ollama).

    Terminal

    brew install this-rs/tap/project-orchestrator# or, without Homebrewcurl -fsSL https://raw.githubusercontent.com/this-rs/project-orchestrator/main/install.sh | sh
  2. 2.Start Neo4j and Meilisearch

    The project memory lives in Neo4j and search runs on Meilisearch. The repository includes a compose file that starts both. The desktop app does this for you.

    Terminal

    git clone https://github.com/this-rs/project-orchestrator.gitcd project-orchestratordocker compose up -d neo4j meilisearch
  3. 3.Run the server

    The server listens on port 8080 by default and serves the web interface too. Open http://localhost:8080 to check that it is running.

    Terminal

    orchestrator serve
  4. 4.Connect Claude Code over MCP

    One command finds Claude Code and adds the project-orchestrator MCP server in stdio mode, with its tools pre-approved. Another MCP client can start mcp_server the same way, with PO_SERVER_URL pointing at your server. Claude Code is not the only engine: add another one (an OpenAI-compatible model, Codex or an ACP agent, all alpha) as a provider on the Providers page of the web interface.

    Terminal

    orchestrator setup-claude
  5. 5.Sync a project and run a plan

    Register your repository and let PO read it. Then ask your assistant for a plan. It calls the MCP tools, and you follow the tasks and steps in the web interface.

    Terminal

    orchestrator sync --path .# then, in Claude Code:> Create a plan to add rate limiting to the public API,> split it into tasks with dependencies, and run it.