Skip to content

README.md

Latest commit

 

History

History
69 lines (48 loc) · 3.02 KB

README.md

File metadata and controls

69 lines (48 loc) · 3.02 KB

Reflow Documentation

Welcome to the Reflow documentation! Reflow is a powerful, actor-based workflow execution engine built in Rust that supports multi-language scripting and cross-platform deployment.

What is Reflow?

Reflow is a modular workflow engine that uses the actor model for concurrent, message-passing execution. It supports:

  • Zeal IDE Integration: Real-time event streaming to Zeal via ZIP protocol (WebSocket + HTTP traces)
  • 6,700+ API Actors: Pre-generated actors for 88 API services (Slack, GitHub, Stripe, etc.)
  • Actor-Based Architecture: Isolated, concurrent actors with message passing
  • Graph-Based Workflows: Visual workflow representation with history/undo
  • Unified Rust Runtime Crate: reflow_rt is the crates.io-facing API surface for graph, actor, network, and component crates
  • Real-Time Observability: EventBridge pipeline forwarding execution events to TraceCollector and ZipSession
  • Media Processing: Image, audio, video, and optional graph-driven ML pipelines
  • REST API + WebSocket: HTTP and WebSocket interfaces for headless workflow execution
  • Cross-Platform: Native Rust execution + WebAssembly for browsers

Documentation Structure

Getting Started

Quick start guide, installation, and basic concepts

Runtime Crate

The public Rust runtime API surface, feature flags, and graph/component re-exports

Architecture

System architecture, actor model, execution engine, and event pipeline

Zeal Integration

ZIP session, template registration, real-time event streaming to Zeal IDE

REST API

HTTP and WebSocket API for direct workflow execution

Core API

Detailed API documentation for actors, messaging, and graphs

Components

Standard component library: flow control, transforms, logic, media, optional ML, and 6,700+ API actors

Observability

EventBridge, TraceCollector, ZIP event translation, and trace sessions

Deployment

Deployment options and operational considerations

Reference

Complete API reference and configuration options

Quick Links

Community and Support

  • GitHub Issues: Report bugs and request features
  • Discussions: Community Q&A and announcements
  • Contributing: See CONTRIBUTING.md for development guidelines

License

This project is dual-licensed under MIT or Apache-2.0 - see the LICENSE files for details.