Skip to main content

What you’ll need

  • Apple Silicon macOS or glibc Linux (x64 or ARM64). Intel Macs and native Windows are not supported.
  • A Circuit account (for uploading agents and hosted dev runs)

Install the CLI

The installer puts one self-contained circuit binary in ~/.local/bin. If that directory is not on your PATH, zsh and bash users get it added to their shell’s startup file and an export line to run in the current terminal; run it or open a new terminal before circuit --version. Other shells need ~/.local/bin added to PATH by hand. Run circuit upgrade to replace the binary with the newest release.

The SDK comes with the CLI

Import from circuit:sdk; the CLI supplies it locally and the hosted runtime supplies it after deployment. Never add the SDK as a project dependency.