Quickstart

Create and deploy your first agent in four steps using the cli. This will create a wireframe agent that will post a simple log to the UI.

Step 1: Authenticate

circuit login

This opens a browser to authenticate with Circuit.

Step 2: Initialize an Agent

circuit init

The CLI prompts you to:

• Select a language (TypeScript or Python)

• Enter an 'Agent Name'

This creates a new directory ('agent-name') with:

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

• Agent configuration file (.circuit.toml)

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

Step 3: Install Dependencies

Navigate to the agent directory and install dependencies:

TypeScript:

cd agent-name
bun install

Python:

cd agent-name
uv sync

Step 4: Test Locally

circuit run

This:

• Creates a test session

• Starts a local agent server

• Executes your agent's run function

• Streams logs to your terminal

Step 5: Deploy

circuit publish

This uploads your agent to Circuit. Once published, users can run your agent through the Circuit app.

Next Steps

• Agent Structure - Understand the generated files

• How It Works - Learn how agents execute

• SDK Reference - Explore SDK capabilities