Getting started
From nothing to your first agent run in about fifteen minutes.
1Run the board server
On the machine that hosts the board:
pnpm install
cp .env.example .env
pnpm dev
In .env, set RUNNER_TOKEN to a long random value; runners use it to connect. For a board others reach over the internet, also set BASIC_AUTH_USER and BASIC_AUTH_PASSWORD and put it behind HTTPS (for example Caddy).
The board opens at http://localhost:5173 in development. For production, build the web app with pnpm --filter @agents-board/web build and run pnpm --filter @agents-board/server start; the server serves the board on port 4100.
2Connect a runner
A runner runs the agent sessions. It needs Claude Code logged in and git access to your repositories.
On the runner machine, put these in the .env of its copy of the board, then start it:
SERVER_URL=https://your-board.example.com
RUNNER_TOKEN=the-same-token
RUNNER_NAME=my-pc
pnpm dev:runner
The runner panel on the board shows it with its Claude login. On Windows, the desktop app has a built-in runner instead (step 4).
Agent sessions stop at Claude Code's folder trust prompt in new folders. Set RUNNER_MANAGE_TRUST=1 to let the runner trust only the work-item folders it creates.
3Your first agent run
- Open Projects…, create a project and paste its repository's clone URL.
- Click New item, write a Feature with a clear description, and assign it to the Analyst.
- Open the card's Terminal tab to watch the session. When the PRD is attached, approve PRD sign-off and the UX Designer starts.
Set AGENT_PERMISSION_MODE=auto in .env to run sessions without approval prompts while Claude Code's safety checks block risky actions.
4Install the desktop app
- Download and run the installer.
- Settings opens on first start: enter your board address and login.
- To run agents on that PC, tick Run agents on this PC, give it a unique runner name and paste the
RUNNER_TOKEN.
5Activate your licence
After you buy Team or Business, your key is shown on the confirmation page and emailed to you. The easiest way in is your board's Licence screen; no restart needed. On the confirmation page, Activate in my board opens that screen with the key already filled in.
- Open your board and go to Licence.
- Paste the key and click Apply.
- Projects… → Edit now has Azure DevOps, Buffer and Zapier, and Runs on.
Or set it in .env
- Open the board server's
.envand addAGENTS_BOARD_LICENSE=followed by the key. - Restart the server. Its log shows
Agents Board team edition, licensed to …. - Refresh the board.
The key is checked offline. When it ends, the board keeps working as Lite until you set a new key. Renew at Pricing and paste your current key at checkout so the new one continues from its end date. Lost your key? Get it again.
Help
Contact us. Team and Business customers get email support; include your order number.