Skip to main content

​
What you’ll need

  • A Circuit account (for publishing agents and hosted dev runs)
  • Bun installed (required for the Circuit CLI and TypeScript agents)
  • Python 3.12+ with uv for Python agents

​
Install the CLI

Install the Circuit CLI using Bun: 
bun install -g @circuitorg/agent-cli
circuit --version
circuit new does not require login. Sign in later when you use account-backed commands such as publish or hosted dev runs.

​
The SDK comes with the CLI

There is nothing else to install. The Circuit SDK is provided by the environment your agent runs in — the CLI locally, the platform when deployed — and is never a dependency of your project:
  • TypeScript agents import from circuit:sdk (the same pattern as node:fs or cloudflare:workers). The CLI keeps a committed circuit-sdk.d.ts at your project root up to date so your editor and tsc resolve it — the same shape Wrangler ships worker-configuration.d.ts.
  • Python agents import from circuit_sdk. The CLI installs the module into your project’s .venv.
If SDK imports ever stop resolving in your editor (for example after a fresh clone), run circuit check — it repairs the SDK installation as part of validating the project.