Quickstart

Get Laddr running and execute your first agent in under 60 seconds.

Prerequisites

Python 3.9+
pip installed
(Optional) Docker for full stack

Step 1: Install Laddr

pip install laddr

Verify installation:

laddr --version

Step 2: Initialize a Project

laddr init my_agent_system
cd my_agent_system

This creates a project structure with:

agents/ - Your agent definitions
workers/ - Worker scripts
docker-compose.yml - Docker configuration
main.py - Runner script

Step 3: Set API Keys

Create a .env file in your project root:

# .env
GEMINI_API_KEY=your_gemini_api_key
SERPER_API_KEY=your_serper_api_key

You can use any LLM provider. Gemini is used in this example, but OpenAI, Anthropic, and Ollama are also supported.

Step 4: Add an Agent

laddr add agent researcher \\
  --role "Research Specialist" \\
  --goal "Find and analyze information" \\
  --llm-model gemini-2.5-flash

Step 5: Add a Tool

laddr add tool web_search \\
  --agent researcher \\
  --description "Search the web for information"

Step 6: Run the Agent

Option A: Local Run (Fastest)

laddr run-local researcher --input '{"query": "What is Laddr?"}'

Option B: Full Stack (Docker)

laddr run dev -d
docker compose up -d

Then submit a job:

laddr prompt run researcher --input query="What is Laddr?"

Expected Output

You should see:

Starting researcher agent...
Processing query: What is Laddr?
Using tool: web_search
Found results: [...]
Agent response: Laddr is an open-source multi-agent framework...
Task completed successfully

What’s Next?

Build Your First Agent

Learn to create custom agents

Explore the Dashboard

Use the web UI to monitor agents

Agent Configuration

Configure agents in detail

Tool Development

Create custom tools

Troubleshooting

Installation Issues

If laddr command not found:

# Add to PATH or use python -m
python -m laddr --version

API Key Errors

Ensure your .env file is in the project root and keys are valid.

Docker Issues

If Docker commands fail, ensure Docker is running:

docker ps

Next Steps

Installation Guide - Detailed setup instructions
First Agent Tutorial - Build a custom agent
Agent Configuration - Configure agents
Tool Development - Create custom tools

Introduction

Getting Started

Guides

Reference

Examples

Community

Prerequisites

Step 1: Install Laddr

Step 2: Initialize a Project

Step 3: Set API Keys

Step 4: Add an Agent

Step 5: Add a Tool

Step 6: Run the Agent

Option A: Local Run (Fastest)

Option B: Full Stack (Docker)

Expected Output

What’s Next?

Build Your First Agent

Explore the Dashboard

Agent Configuration

Tool Development

Troubleshooting

Installation Issues

API Key Errors

Docker Issues

Next Steps

​Prerequisites

​Step 1: Install Laddr

​Step 2: Initialize a Project

​Step 3: Set API Keys

​Step 4: Add an Agent

​Step 5: Add a Tool

​Step 6: Run the Agent

​Option A: Local Run (Fastest)

​Option B: Full Stack (Docker)

​Expected Output

​What’s Next?

Build Your First Agent

Explore the Dashboard

Agent Configuration

Tool Development

​Troubleshooting

​Installation Issues

​API Key Errors

​Docker Issues

​Next Steps

Prerequisites

Step 1: Install Laddr

Step 2: Initialize a Project

Step 3: Set API Keys

Step 4: Add an Agent

Step 5: Add a Tool

Step 6: Run the Agent

Option A: Local Run (Fastest)

Option B: Full Stack (Docker)

Expected Output

What’s Next?

Troubleshooting

Installation Issues

API Key Errors

Docker Issues

Next Steps