OpenAgentFlow
OpenAgentFlow Documentation
What OpenAPI is for REST APIs, OpenAgentFlow (
.oaf) is for AI agent workflows.
Welcome to the OpenAgentFlow documentation. OpenAgentFlow is an open, portable specification and compiler for defining executable multi-agent AI workflows using a clean, human-readable text format.
Getting Started
New to OpenAgentFlow? Start here:
- Installation — Set up Node.js, Python, and API keys
- Quick Start — Create and run your first workflow in 5 minutes
- Official Starter Repository — Clone our template (
git clone https://github.com/OpenAgentFlow/OpenAgentFlow-starter.git) for instant, zero-config workflow execution
Core Concepts
Understand how OpenAgentFlow works under the hood:
- Architecture — Pipeline overview, design principles, and module map
- Project Structure — Directory layout and entry points
- Workflow Lifecycle — From
.oafsource to live execution
Language Reference
- The
.oafLanguage — Complete language syntax: workflow, state, agent, flow, and config blocks
Components
Deep dives into each compiler module:
- Parser — Lexer, AST, and recursive-descent parser
- Compiler — Validator, IR generator, and pipeline orchestrator
- Adapters — LangGraph adapter and Python code generation
CLI
- CLI Reference — All commands, flags, and environment variables
Guides
- Configuration — Environment variables, LLM providers, and state injection
- Best Practices — Workflow design patterns, agent tips, and testing
- Troubleshooting — Common errors, FAQ, and debugging
Examples
- Examples & Tutorials — Walk through every built-in example and build your own
API Reference
- Programmatic API — All public classes, methods, and types
- IR Schema — Intermediate Representation JSON format
Specifications
The formal language specifications live in the spec/ directory:
| Document | Description |
|---|---|
| SPEC.md | Core language syntax and constructs |
| GRAMMAR.md | Formal EBNF grammar |
| SEMANTICS.md | 3-phase semantic validation rules |
| IR.md | Intermediate Representation schema |
Project Status
| Phase | Status |
|---|---|
| Phase 1 — Specification | ✅ Complete |
| Phase 2 — Compiler MVP | ✅ Complete |
| Phase 3 — Runtime Integration | ✅ Complete |
| Phase 4 — State Initialization | ✅ Complete |
| Phase 4.5 — Multi-Provider, Auth & Tooling | ✅ Complete |
| Phase 5 — Additional Adapters | 🔲 Planned |
| Phase 6 — Developer Tooling | 🔲 Planned |
OpenAgentFlow is open-source under the MIT License.