Complete Tutorial¶
Welcome to the full HiveFlow tutorial. This series walks you from zero to production: Core engine, Agent runtime, Studio UI, security, scaling, and integrations.
Who this is for¶
| Audience | Recommended path |
|---|---|
| New users | Part 1 → Part 2 → Part 5 (Studio) |
| Library embedders | Part 1 → Part 2 → Part 3 |
| Ops / platform | Part 5 → Part 6 |
| LangGraph users | Part 4 + LangGraph Sidecar · Ecosystem compatibility |
Prerequisites¶
- Python 3.10+
gitandpip- Optional: Docker Desktop (Studio full stack)
- Optional: Redis (distributed blackboard)
- Optional: Node.js 18+ (Studio frontend dev)
Learning path¶
flowchart LR
P1[Part 1 Foundation] --> P2[Part 2 Workflows]
P2 --> P3[Part 3 Advanced]
P2 --> P5[Part 5 Studio]
P3 --> P4[Part 4 Integrations]
P5 --> P6[Part 6 Production]
P4 --> P6
| Part | Topics | Examples |
|---|---|---|
| Part 1 — Foundation | Install, repo layout, ECM, agents, blackboard | 01 |
| Part 2 — Workflows | Multi-agent, HITL, checkpoint, streaming, RAG, MCP | 02–07 |
| Part 3 — Advanced | Cognitive planning, evaluation, security, scale, plugins, guards | 08–14 |
| Part 4 — Integrations | Multimodal, LangGraph export | 15–16 |
| Part 5 — Studio | Orchestrator, Chatflow, HITL UI, analytics, replay | Docker / local Studio |
| Part 6 — Production | Deploy, observability, troubleshooting, repo map | deployment.md |
Quick start (5 minutes)¶
git clone https://github.com/jdidjhdh/hiveflow.git
cd hiveflow
docker compose up --build
Open http://localhost:3000 → Orchestrator → enable Agent / real mode → enter a goal → Plan only → Import to canvas → Execute DAG.
Or without Docker:
pip install -e packages/core -e packages/agent
python examples/01_hello_hiveflow.py
Runnable examples index¶
All 16 examples are smoke-tested in CI:
pip install -e "packages/core[all]"
python examples/run_smoke_tests.py
| # | File | Tutorial section |
|---|---|---|
| 01 | 01_hello_hiveflow.py |
Part 1 |
| 02 | 02_multi_agent.py |
Part 2 |
| 03 | 03_hitl_approval.py |
Part 2 + Cookbook HITL |
| 04 | 04_checkpoint.py |
Part 2 + Cookbook checkpoint |
| 05 | 05_streaming.py |
Part 2 |
| 06 | 06_rag_pipeline.py |
Part 2 + Cookbook RAG |
| 07 | 07_mcp_tools.py |
Part 2 |
| 08 | 08_cognitive_planning.py |
Part 3 |
| 09 | 09_evaluation.py |
Part 3 |
| 10 | 10_secure_blackboard.py |
Part 3 |
| 11 | 11_distributed_agents.py |
Part 3 |
| 12 | 12_custom_scheduler.py |
Part 3 |
| 13 | 13_plugin_development.py |
Part 3 |
| 14 | 14_guard_configuration.py |
Part 3 |
| 15 | 15_multimodal_pipeline.py |
Part 4 |
| 16 | 16_langgraph_export.py |
Part 4 + LangGraph Sidecar |
Related docs¶
- Getting Started — condensed quick start
- Concepts — ECM, Cell, Scheduler terminology
- Architecture — system design
- Cookbook — scenario deep-dives
- API Reference — HTTP and Python APIs