Quickstart Guide

Get AgentBreeder running in under 10 minutes.

Install

pip install agentbreeder

brew tap rajitsaha/agentbreeder
brew install agentbreeder

docker pull rajits/agentbreeder-cli

npm install @agentbreeder/sdk

import { Agent } from "@agentbreeder/sdk";

const agent = new Agent("my-agent", { version: "1.0.0", team: "eng" })
  .withModel({ primary: "claude-sonnet-4", fallback: "gpt-4o" })
  .withDeploy({ cloud: "aws", region: "us-east-1" });

agent.toYaml("agent.yaml");

git clone https://github.com/rajitsaha/agentbreeder.git
cd agentbreeder
python -m venv venv && source venv/bin/activate
pip install -e ".[dev]"

Verify:

agentbreeder --help

Create Your First Agent

agentbreeder init

The interactive wizard asks 5 questions:

Framework — LangGraph, OpenAI Agents, Claude SDK, CrewAI, Google ADK, or Custom
Cloud target — Local, AWS, GCP, or Kubernetes
Agent name — lowercase with hyphens (e.g., support-agent)
Team — your team name
Owner email — who is responsible

It generates a ready-to-run project:

my-agent/
├── agent.yaml          # Configuration — the only file AgentBreeder needs
├── agent.py            # Working agent code for your chosen framework
├── requirements.txt    # Python dependencies
├── .env.example        # Environment variable template
└── README.md           # Getting started guide

Validate

cd my-agent
agentbreeder validate agent.yaml

This runs three checks:

YAML syntax — is the file valid YAML?
JSON Schema — do all fields match the agent.yaml spec?
Semantic validation — is the framework supported? Is the team valid?

Deploy Locally

agentbreeder deploy agent.yaml --target local

This triggers the 8-step atomic pipeline:

✅  YAML parsed & validated
✅  RBAC check passed
✅  Dependencies resolved
✅  Container built (langgraph runtime)
✅  Deployed to Docker Compose
✅  Health check passed
✅  Registered in org registry
✅  Endpoint returned

If any step fails, the entire deploy rolls back. No partial deploys.

Verify It's Running

# Check deploy status
agentbreeder status

# Tail the logs
agentbreeder logs my-agent --follow

# Chat with your agent
agentbreeder chat my-agent

Deploy to the Cloud

# GCP Cloud Run
agentbreeder deploy agent.yaml --target cloud-run --region us-central1

# AWS ECS Fargate
agentbreeder deploy agent.yaml --target ecs-fargate --region us-east-1

# AWS App Runner (serverless — no VPC or ALB needed)
agentbreeder deploy agent.yaml --target app-runner --region us-east-1

# Azure Container Apps
agentbreeder deploy agent.yaml --target container-apps

# Anthropic Claude Managed Agents (no container build)
agentbreeder deploy agent.yaml --target claude-managed

For cloud: aws targets, set the following in deploy.env_vars:

deploy:
  cloud: aws
  runtime: app-runner      # or: ecs-fargate
  env_vars:
    AWS_ACCOUNT_ID: "123456789012"
    AWS_REGION: us-east-1

For cloud: claude-managed, add an ANTHROPIC_API_KEY secret and an optional claude_managed: block:

deploy:
  cloud: claude-managed
  secrets:
    - ANTHROPIC_API_KEY

claude_managed:
  environment:
    networking: unrestricted
  tools:
    - type: agent_toolset_20260401

Run the Full Platform Locally

If you want the dashboard, registry, and API server running locally:

git clone https://github.com/rajitsaha/agentbreeder.git
cd agentbreeder

python -m venv venv && source venv/bin/activate
pip install -e ".[dev]"
cp .env.example .env

# Start postgres + redis + API + dashboard
docker compose -f deploy/docker-compose.yml up -d

Service	URL
Dashboard	http://localhost:3001
API	http://localhost:8000
API Docs	http://localhost:8000/docs

Default login:

Field	Value
Email	`admin@agentbreeder.local`
Password	`plant`
Role	Admin

Warning

Change the default password before exposing this to a network.

Use Local Models with Ollama

No cloud API keys? Use Ollama for fully local development:

# agent.yaml
model:
  primary: ollama/llama3
  gateway: ollama

ollama serve &
ollama pull llama3
agentbreeder deploy agent.yaml --target local

Next Steps

What	Where
All CLI commands	CLI Reference
Every agent.yaml field	agent.yaml Reference
Multi-agent pipelines	Orchestration Guide
Common workflows	How-To Guide
Migrate from another framework	Migration Guides

Quickstart

On this page