Quickstart

Get Clustr running in under a minute.

1. Install and launch

Run Clustr directly with npx — no global install needed:

npx clustr-ai

This downloads, builds, and starts the Clustr server. On first run it may take a moment to compile.

2. Open the dashboard

Once the server is running, open your browser to:

http://localhost:3100

You'll see the Clustr workspace with the agent graph, terminal tabs, messaging panel, and context viewer.

3. Open a project

Click Open Project in the title bar to select a project directory. This sets the working directory for all new agents.

4. Spawn your first agent

Click New Agent to open the spawn dialog. Fill in:

• Name — a descriptive name (e.g., frontend-refactor)
• Task — what the agent should work on
• Service — choose claude or codex

The agent starts in its own terminal. You can watch its output live, and it will automatically connect to the workspace for inter-agent communication.

5. Spawn more agents

Repeat step 4 to add more agents. They'll discover each other automatically and can communicate via messages and shared context. You can also use the Rules file to give all agents shared rules and instructions.

Environment variables