Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

README.md

cascadeflow Documentation

Full documentation is now at docs.cascadeflow.dev — the Mintlify-powered docs site is the primary reference for cascadeflow's agent runtime intelligence layer. The guides below remain for quick reference and deep links.

Agent runtime intelligence layer — optimize cost, latency, quality, budget, compliance, and energy across AI agent workflows. In-process harness, not a proxy.

Quick Links

🚀 Getting Started

Core Concepts

  • Quickstart - Get started with cascadeflow in 5 minutes
  • Python Harness Quickstart - init, run, and @agent for in-process policy control
  • Providers - Configure and use different AI providers (OpenAI, Anthropic, Groq, Ollama, etc.)
  • Presets - Use built-in presets for common use cases
  • Gateway Server - Drop-in OpenAI/Anthropic-compatible endpoint for existing apps

Core Features

🏭 Production & Advanced

Production Deployment

Advanced Topics

Integrations

📚 Examples

Comprehensive working code samples:

Python Examples: examples/

  • Basic usage, preset usage, multi-provider
  • Tool execution, streaming, cost tracking
  • Production patterns, FastAPI integration
  • Edge device deployment, vLLM integration
  • Custom cascades and validation

TypeScript Examples: packages/core/examples/

  • Basic usage, tool calling, multi-provider
  • Streaming responses
  • Production patterns
  • Browser/Vercel Edge deployment

🤝 Need Help?

📦 API Reference

Comprehensive API documentation for all classes and methods:

See also: Comprehensive examples in /examples directory

🏗️ Architecture & Contributing

For contributors and advanced users:

The architecture guide covers:

  • Directory structure (monorepo layout)
  • Core components and design patterns
  • Data flow and execution paths
  • Adding new providers, quality checks, and routing strategies
  • Testing strategy and development workflow