CLI Reference

Global Flags

Flag	Description	Example
-h, --help	Show help information	circuit --help
-v, --version	Show version information	circuit --version

Core Commands

Command	Description
circuit whoami	Show current authenticated user
circuit login	Authenticate with Circuit platform
circuit logout	Sign out from Circuit platform
circuit init	Initialize a new agent project
circuit run	Run/test your agent
circuit stop	Stop a running agent session
circuit publish	Publish agent to production
circuit help	Show detailed help and getting started guide
circuit info	Display CLI and current agent information

Wallet commands

Command	Description
circuit wallet list	List your available wallets
circuit wallet import	Import a new wallet for testing

Command Details

circuit init

Creates a new agent project.

• Prompts for language (TypeScript or Python) and agent name

• Generates project structure with .circuit.toml config file

Optional Flag	Description
--no-dir	Initialize in the current folder instead of creating a new one

# Creates a new project folder
circuit init

# Initializes in the current folder
circuit init --no-dir

circuit run

Runs your un-published agent code.

• Creates a session if needed

• Starts local agent server

Optional Flags	Description
--wallet <address>	Specify wallet address
--mode local|live|custom	Set simulation mode
--action execute|stop	Executes agent's run or stop function
--port <number>	Port for custom server mode

# Interactive mode
circuit run

# Skip prompts with flags
circuit run --wallet 0xabc... --mode local --action execute

# Connect to custom server
circuit run --mode custom --port 8080

# Stop simulation with custom server
circuit run --mode custom --port 8080 --action stop

circuit stop

Stops a running agent session and cleans up resources.

Optional Flags	Description
--wallet <address>	Specify wallet address

# Interactive mode
circuit stop

# Skip prompt with flag
circuit stop --wallet 0xabc...