Getting Started

This guide walks you through installing ClaudeControl and launching your first agent.

Prerequisites

• Node.js 20+ -- check with node -v
• Claude Code CLI installed and logged in -- verify with claude --version

Installation

Install globally from npm:

npm install -g @lucashca/claudecontrol

Starting the server

Run the CLI command to start the dashboard:

claudecontrol

By default the server starts on port 22609. Override it with the PORT environment variable:

PORT=3000 claudecontrol

Opening the dashboard

Open your browser at:

http://localhost:22609

Creating your first workspace

1. Click New Workspace in the sidebar.
2. Give it a name (e.g. "my-project").
3. Select the project directory using the file browser, or type the absolute path.
4. Click Create.

The dashboard detects available agent roles from your project's CLAUDE.md and any role-specific markdown files in the .claude/ directory.

Spawning your first agent

1. Open the workspace you just created.
2. Pick a role from the role selector (e.g. "code", "review", or any custom role detected from your project).
3. Optionally set an initial task message.
4. Click Spawn.

The agent starts immediately. You will see its output streaming in real time in the chat panel. You can send follow-up messages, attach files, stop the agent, or spawn additional agents in the same workspace.

Next steps

• Configuration -- customize runtime settings, set a PIN, and configure environment variables.
• Development -- run ClaudeControl locally for development.
• API Reference -- integrate with the REST and WebSocket APIs.