orcheo 0.20.1

Add your description here

Orcheo

Orcheo is a workflow orchestration platform designed for vibe coding — AI coding agents like Claude Code can start services, build workflows, and deploy them for you automatically. Read the full documentation for guides, API reference, and examples.

Note: This project is currently in Beta. Expect breaking changes as we iterate rapidly towards 1.0.

SIGIR Reviewers: See the Conversational Search Examples for step-by-step demos from basic RAG to production-ready search.

Why Orcheo?

• Vibe-coding-first: Already using Claude Code, Codex CLI, or Cursor? You don't need to learn Orcheo. Install the agent skill and let your AI agent handle setup, workflow creation, and deployment.
• Python-native: Workflows are Python code powered by LangGraph — no proprietary DSL to learn.
• Backend-first: Run headless in production; the UI is optional.

Prerequisites

• Docker — for running Redis and other services
• Python 3.12+ — required for the backend
• uv — Python package manager (installation guide)

Quick Start

The fastest way to get started with Orcheo is through the Agent Skill approach — let your AI coding agent handle the setup for you.

Note: Most AI coding agents (Claude Code, Codex CLI, Cursor) require a paid subscription. Free alternatives may exist but have not been tested with Orcheo.

1. Install the Orcheo Agent Skill

Add the Orcheo agent skill to your AI coding agent (Claude Code, Cursor, etc.) by following the installation instructions in the repo.

2. Let Your Agent Do the Work

Once installed, simply ask your agent to:

• Set up Orcheo: "Set up Orcheo for local development"
• Create workflows: "Create a workflow that monitors RSS feeds and sends Slack notifications"
• Deploy workflows: "Deploy and schedule my workflow to run every hour"

Your AI agent will automatically:

• Install dependencies
• Start the backend server
• Create and configure workflows
• Handle authentication and deployment

That's it! Your agent handles the complexity while you focus on describing what you want your workflows to do.

Guides

• Manual Setup Guide — Installation, CLI reference, authentication, and Canvas setup
• Conversational Search Examples — Step-by-step demos from basic RAG to production-ready search

# Quick start: Run Demo 1 (no external services required)
uv sync --group examples
orcheo credential create openai_api_key --secret sk-your-key
python examples/conversational_search/demo_2_basic_rag/demo_2.py

Reference

• SDK Reference — Python SDK for programmatic workflow execution
• Environment Variables — Complete configuration reference

For Developers

• Developer Guide — Repository layout, development environment, and custom nodes
• Deployment Guide — Docker Compose and PostgreSQL deployment recipes
• Custom Nodes and Tools — Extend Orcheo with your own integrations

Contributing

We welcome contributions from the community:

• Share your extensions: Custom nodes, agent tools, and workflows that extend Orcheo's capabilities. See the Custom Nodes and Tools guide for how to create and load custom extensions.
• How to contribute: Open an issue, submit a pull request, or start a discussion. You can also publish and share your extensions independently for others to install.

Citation

If you use Orcheo in your research, please cite it as:

@software{jiang2025orcheo,
  author       = {Jiang, Shaojie},
  title        = {Orcheo: A Workflow Orchestration Platform for Vibe Coding},
  year         = {2025},
  publisher    = {GitHub},
  url          = {https://github.com/ShaojieJiang/orcheo}
}