Skip to main content

​
What you’ll need

  • A Circuit account (for uploading agents and hosted dev runs)
  • Bun, which the installer adds when it is not already on your PATH

​
Install the CLI

Install the Circuit CLI with the dev installer:
The dev installer installs Bun first if it is not already on your PATH. circuit new does not require login. Sign in later when you use account-backed commands such as upload or hosted dev runs. You can also install directly with Bun:

​
Continue from Agent Builder

The Agent Builder’s Continue locally command installs the CLI if needed, signs you in, downloads the Workspace, and installs project dependencies:
The files land in ./<agent-name>/. The command contains no credential; it uses the normal circuit auth login browser/passkey flow.

​
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 hosted runtime 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. 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.