OpenAgentFlow (.oaf) Starter Project

What OpenAPI is for REST APIs, OpenAgentFlow is for AI agent workflows.

Welcome! This template repository lets you instantly build, test, and compile multi-agent workflows using OpenAgentFlow (.oaf).

Quick Start

1. Clone the Starter Project (or click "Use this template"):

   git clone https://github.com/OpenAgentFlow/OpenAgentFlow-starter.git my-agents
   cd my-agents

2. Install Dependencies & Auto-Setup Environment: Run our automated cross-platform setup script (setup.js), which initializes your local Python virtual environment (venv), installs LangGraph requirements, and sets up your .env file automatically:

   npm install
   npm run setup

3. Configure API Keys: Set your keys interactively via the OpenAgentFlow CLI (or edit your .env file directly):

   npx openagentflow auth

4. Run Pre-built Workflows Live:

   # Run Customer Support Triage Workflow
   npm run triage
   
   # Run Software Dev Pipeline
   npm run dev-flow

5. Compile to Python LangGraph App:

   npm run compile-triage
   # Activate venv when running compiled python script directly:
   # Windows PowerShell: .\venv\Scripts\Activate.ps1
   # macOS/Linux: source venv/bin/activate
   python triage_app.py

🐳 Dev Containers & GitHub Codespaces

This repository includes a preconfigured Development Container (.devcontainer/devcontainer.json).

• VS Code: Install the Dev Containers extension, open the project, and select Reopen in Container.
• GitHub Codespaces: Open this repo in Codespaces for an instant, zero-setup browser environment with Node 22, Python 3.11, venv, and OpenAgentFlow extensions ready out of the box!