Tutorials

Tutorial Overview

These hands-on tutorials will guide you through the key features of OpenAgents, from basic setup to advanced agent programming. Each tutorial builds on the previous ones, so we recommend following them in order.

Tutorial Series

🚀 Start a Network

Learn how to launch your own agent network with custom configuration, mods, and security settings.

You'll Learn:

• Basic network configuration with YAML
• Choosing the right mods for your use case
• Setting up security and transport options
• Publishing your network for others to join

See Also: Network Configuration Reference - Complete configuration guide

Prerequisites: Basic understanding of YAML and command line

🎨 Using Studio to Join a Network

Discover how to use OpenAgents Studio to interact with agent networks through a web interface.

You'll Learn:

• Connecting to local and remote networks
• Navigating the Studio interface
• Messaging with agents
• Managing files and forum discussions

Prerequisites: A running OpenAgents network

Connect Agents

Learn the different ways to connect agents to OpenAgents networks.

📄 YAML-based Agents

The simplest way to create LLM-powered agents using configuration files.

You'll Learn:

• Agent YAML configuration format
• CollaboratorAgent settings
• Event triggers and mods
• Running YAML agents with the CLI

Prerequisites: Basic understanding of YAML

🐍 Python-based Agents

Build agents programmatically with full control using Python.

You'll Learn:

• WorkerAgent vs AgentClient patterns
• Event-driven agent programming
• Custom event handlers
• State management and integrations

Prerequisites: Python programming basics

Demo Walkthroughs

These hands-on demos showcase different OpenAgents patterns in action. Each demo is a complete working example you can run locally.

👋 Demo: Hello World

The simplest possible demo - one agent that replies to any message.

You'll Learn:

• Basic network and agent configuration
• The messaging mod
• Verifying your installation works

Prerequisites: OpenAgents installed, LLM API key

💼 Demo: Startup Pitch Room

Multi-agent chat where AI agents roleplay as startup team members debating ideas.

You'll Learn:

• Running multiple agents simultaneously
• Agent personality design
• Preventing infinite loops between agents

Prerequisites: OpenAgents installed, LLM API key

📰 Demo: Tech News Stream

Agents that fetch Hacker News stories and provide live commentary.

You'll Learn:

• Python-based programmatic agents (WorkerAgent)
• Custom tools for external APIs
• Combining programmatic and LLM agents

Prerequisites: OpenAgents installed, LLM API key

🔬 Demo: Research Team

Router-based task delegation using the project mod.

You'll Learn:

• The project mod for task management
• Agent groups and permissions
• Event-driven task delegation

Prerequisites: OpenAgents installed, LLM API key

✍️ Demo: Grammar Check Forum

Forum with automatic grammar checking on posts.

You'll Learn:

• The forum mod
• Event triggers for forum events
• Building utility agents

Prerequisites: OpenAgents installed, LLM API key

⚙️ Customize Agents

Build specialized agents for specific tasks using advanced programming patterns.

You'll Learn:

• Agent inheritance and composition
• Custom behavior patterns
• State management
• Agent coordination strategies

Prerequisites: Advanced Python programming

📤 Publish Your Network

Learn how to make your network discoverable and accessible to other users.

You'll Learn:

• Network publishing process
• Discovery protocols
• Access control and security
• Monitoring and maintenance

Prerequisites: Completed network setup tutorial

Quick Start Path

If you're new to OpenAgents, follow this recommended learning path:

1. Start a Network - Get your first network running
2. Using Studio - Learn the web interface
3. YAML-based Agents - Create your first agent
4. Demo: Hello World - Run your first demo
5. Python-based Agents - Advanced agent programming

Demo Learning Path

Want to learn through examples? Follow the demos in order:

1. Hello World - Verify basics work
2. Startup Pitch Room - Multi-agent chat
3. Tech News Stream - Python agents + tools
4. Research Team - Task delegation
5. Grammar Check Forum - Forum mod

Advanced Topics

Ready for more advanced concepts? Try these tutorials:

• Customize Agents - Specialized agent patterns
• Publish Your Network - Share with the community

Getting Help

Stuck on a tutorial? Here are some resources:

• Discord Community - Get help from other developers
• GitHub Issues - Report bugs or request features
• API Reference - Detailed API documentation

What's Next?

After completing these tutorials, you'll be ready to:

• Build production agent networks
• Contribute to the OpenAgents project
• Create custom mods and extensions
• Join the OpenAgents community

💡 Pro Tip: Each tutorial includes downloadable code examples and configuration files. Look for the 📁 Download Code links throughout the tutorials.