Development

CLI commands for developing and testing agents locally.

Initialize new agent

Initialize a new agent project and generate a template agent.

circuit init

Prompts:

• Language selection (TypeScript or Python)

• Agent name

Creates:

• Agent code template (index.ts or main.py)

• Configuration file (.circuit.toml)

• Dependency file (package.json or pyproject.toml)

Output:

• Creates a new directory with the agent name (slug)

• Prints project directory path

Execute the agent's run function

Test your agent locally.

Note: You will need to make sure that all required packages are installed and included in your pyproject.toml/package.json dependencies using 'uv sync' or 'bun install'. See the quickstart guide for more detals.

circuit run
circuit run --wallet <address>

Flags:

• --wallet / -w: Specify wallet address for testing

Behavior:

• Creates a test session if needed

• Starts local agent server

• Executes your agent's run function

• Streams logs to terminal

Output:

• Real-time log streaming

• Session ID and wallet address

• Execution results

Execute the agent's unwind function

Unwind a running agent session.

circuit unwind
circuit unwind --wallet <address>

Flags:

• --wallet / -w: Specify wallet address

Behavior:

• Unwinds the agent session

• Cleans up resources

• Calls your agent's unwind function