Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ctrlnode.ai/llms.txt

Use this file to discover all available pages before exploring further.

Get from zero to a dispatched first task in about fifteen minutes. You need an account at app.ctrlnode.ai and a machine where you can run the open-source Bridge.

​
Overview

StepRouteWhat you do
1/setup/projectName the project and pick default agent type (CLI)
2/setup/tokenInstall Bridge, generate pairing token, wait until connected
3/setup/agentCreate your first agent (requires Bridge online)
4/setup/taskCreate and dispatch a task to the agent
When step 4 succeeds, setup_completed_at is set and you land in the normal app (dashboard, Kanban, workflows).
Use in-app navigation between setup steps. Avoid hard-refreshing mid-wizard or you may see a loading screen.

​
Step 1 — Project

  • Project name and slug (auto-filled from the name)
  • Agent type — default CLI badge for the project (Claude, Copilot, Cursor, Gemini, Codex, Hermes, OpenClaw)
Continue to Token with ?projectId=<uuid>.

​
Step 2 — Pair the Bridge

The Bridge dials out to CtrlNode. You do not open inbound ports.

​
Install

irm https://github.com/ctrlnode-ai/ctrlnode/releases/latest/download/install.ps1 | iex

​
Pairing token

On the token step, click GENERATE TOKEN →, copy it once, then run: 
$env:PAIRING_TOKEN="<paste-token>"; ctrlnode-bridge
Or run ctrlnode-bridge and complete the interactive wizard (writes ~/.ctrlnode/.env).
You can create more tokens later under System → Bridge Setup (/system/bridge-tokens). See Bridge configuration for PROVIDERS and API keys.
Wait until the UI shows connected, then continue.

​
Step 3 — Agent

Requires Bridge connected.
  • Name (required), optional role, model, and instructions
  • If exactly one agent is registered on the Bridge, it may auto-link

​
Step 4 — First task

  • Title and agent instructions (markdown supported)
  • Optional input files uploaded before dispatch
  • Submit sets status to inbox and sends work to the Bridge

​
What’s next

GoalDoc
Mission overviewDashboard
Day-to-day workTasks
Tokens in the UIBridge Setup
Bridge internalsBridge overview

​
Troubleshooting

Confirm the process is running, the token is correct, and SAAS_URL matches your environment. See Bridge configuration.
Finish step 2 until connected. Regenerate a token from Bridge Setup if needed.
A value in your terminal can override ~/.ctrlnode/.env. Unset $env:PAIRING_TOKEN (Windows) or unset PAIRING_TOKEN (Unix) before starting the Bridge.