Getting Started with FlockΒΆ
Welcome to Flock! This section will help you get up and running quickly with the blackboard multi-agent framework.
π Quick LinksΒΆ
-
π¦ Installation
Install Flock and configure your environment in just a few minutes.
-
β‘ Quick Start
Build your first agent in 5 minutes. Zero prompts, zero graph wiring, just type contracts.
-
π‘ Core Concepts
Understand the four core concepts: Flock, Agents, Artifacts, and Blackboard.
Learning PathΒΆ
New to Flock? Follow this recommended learning path:
-
Installation (5 minutes) Set up Flock and configure your API keys
-
Quick Start (5 minutes) Build your first pizza-ordering agent
-
Core Concepts (15 minutes) Understand how Flock's blackboard architecture works
-
User Guides (ongoing) Dive deep into agents, blackboard patterns, and advanced features
What Makes Flock Different?ΒΆ
Traditional Frameworks β You write prompts and define workflow graphs
Flock β You define typed artifacts and let workflows emerge from subscriptions
# No prompts. No graphs. Just contracts.
agent = (
flock.agent("pizza_master")
.consumes(PizzaIdea) # Subscribe to inputs
.publishes(Pizza) # Declare outputs
)
Agents automatically execute when their input types appear on the blackboard. No hardcoded edges. No orchestration code. Just clean, composable type contracts.
Next StepsΒΆ
-
Build Multi-Agent Systems
Learn how to coordinate multiple agents through the blackboard.
-
Master the Blackboard
Understand artifact flows, batching, and parallel execution.
-
Add Real-Time Dashboard
Visualize agent execution with the built-in React dashboard.
-
Enable Production Tracing
Monitor and debug with OpenTelemetry and DuckDB.
Need Help?ΒΆ
- π Documentation: You're already here!
- π¬ Discussions: GitHub Discussions
- π Issues: GitHub Issues
- π¦ PyPI: flock-core
Ready to start? β Install Flock