Commands
| Command | Description |
|---|---|
circuit signin | Authenticate via browser (details) |
circuit signout | Clear stored session (details) |
circuit whoami | Show current user (details) |
circuit new | Create new agent project (details) |
circuit run | Execute agent locally (details) |
circuit unwind | Unwind positions and end session (details) |
circuit check | Validate project offline (details) |
circuit publish | Publish to Circuit infrastructure (details) |
circuit wallet list | List available wallets (details) |
circuit wallet import | Import a test wallet (details) |
Global Flags
Available on all commands:| Flag | Short | Description |
|---|---|---|
--path <path> | -p | Agent project directory (default: current directory) |
--json | -j | Output results as JSON |
--help | -h | Show command help |
circuit new Flags
| Flag | Short | Values | Description |
|---|---|---|---|
--language | -l | typescript, python | Skip language prompt |
--name | -n | any string | Skip name prompt |
--template | -t | basic, yield, polymarket, hyperliquid | Skip template prompt |
circuit run Flags
| Flag | Short | Description |
|---|---|---|
--wallet <address> | -w | Wallet address (skips prompt) |
--mode <mode> | -m | auto or manual (default: first in allowedExecutionModes) |
--amount <amount> | -a | Token amount in smallest unit |
--local-sdk-dependencies | -l | Skip automatic dependency installation |
circuit unwind Flags
| Flag | Short | Description |
|---|---|---|
--wallet <address> | -w | Wallet address (skips prompt) |
--local-sdk-dependencies | -l | Skip automatic dependency installation |
circuit publish Flags
| Flag | Short | Description |
|---|---|---|
--env KEY=VALUE | -e | Set/override env var (repeatable) |
circuit whoami Flags
| Flag | Short | Description |
|---|---|---|
--show-auth | -a | Print base64 auth token for CI/CD |
circuit check Output
Validates offline (no auth required):
- Config structure (valid
circuit.toml) - Entry point exists (
index.tsormain.py) - Handler export (
agent.getExport()oragent.get_handler()) - SDK version pinning
- Environment variable cross-referencing
File Exclusion (Publish)
Automatically excluded from uploads:| Category | Patterns |
|---|---|
| Version control | .git/**, .svn/** |
| Dependencies | node_modules/**, dist/**, venv/**, __pycache__/** |
| Secrets | *.key, *.pem |
| IDE | .vscode/**, .idea/**, *.swp |
| Build artifacts | coverage/**, .pytest_cache/**, .cache/** |
| Lock files | package-lock.json, yarn.lock, pnpm-lock.yaml |
| Other | Dockerfile, docker-compose.yml, *.md, *.sh, *.log, .DS_Store |
filesToExclude in circuit.toml.
Environment Variables
- Source:
.envin project root +--envCLI flags (flags take precedence) - Storage: Encrypted at rest, decrypted at deploy time
- Access:
process.env.KEY(TypeScript) /os.getenv("KEY")(Python) - Limit: 4 KB total (including system vars)
- Rotation: Republish to update
Auth Storage
Credentials stored at~/.config/circuit/auth.json after circuit signin.