Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.circuit.org/llms.txt

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

​
What you’ll need

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

​
Step 1: 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 wallet actions.

​
Step 2: SDK (Python OR TypeScript)

Choose either Python or TypeScript to develop your agent in, then install the respective SDK. If you use circuit new, the generated project already includes the SDK dependency in the project files.

​
Python SDK

Install the Circuit Agent SDK using uv: 
uv pip install circuit-agent-sdk

​
TypeScript SDK

Install the Circuit Agent SDK using bun: 
bun add @circuitorg/agent-sdk