# FlowDSL

> The open DSL for executable event-driven flows. A domain-specific language for describing flow graphs, nodes, edges, and delivery semantics.

## Documentation Sets

- [FlowDSL Documentation](https://flowdsl.com/llms-full.txt): Complete reference for FlowDSL — the domain-specific language for event-driven orchestration. Covers concepts, tutorials, guides, and full spec reference.

## Docs

- [Code of Conduct](https://flowdsl.com/raw/docs/community/code-of-conduct.md): The FlowDSL community code of conduct — standards for participation in all community spaces.
- [Contributing](https://flowdsl.com/raw/docs/community/contributing.md): How to contribute to FlowDSL — spec, SDKs, Studio, and documentation.
- [Community](https://flowdsl.com/raw/docs/community.md): How to get involved with FlowDSL — GitHub, Discord, RFCs, and more.
- [Core Concepts](https://flowdsl.com/raw/docs/concepts.md): Nodes, edges, delivery modes, and how they fit together.
- [Checkpoints](https://flowdsl.com/raw/docs/concepts/checkpoints.md): How the checkpoint delivery mode enables pipeline resumption after failure in FlowDSL.
- [Delivery Modes](https://flowdsl.com/raw/docs/concepts/delivery-modes.md): The five delivery modes that govern how packets move between nodes, with guarantees, use cases, and YAML examples for each.
- [Edges](https://flowdsl.com/raw/docs/concepts/edges.md): Edges connect nodes and carry delivery policies that govern how packets flow between them.
- [Flows](https://flowdsl.com/raw/docs/concepts/flows.md): What a FlowDSL flow is, its structure, lifecycle, and how the runtime executes it.
- [Concepts](https://flowdsl.com/raw/docs/concepts.md): Core concepts behind the FlowDSL specification.
- [Node Registry](https://flowdsl.com/raw/docs/concepts/node-registry.md): How FlowDSL discovers and connects to node implementations.
- [Nodes](https://flowdsl.com/raw/docs/concepts/nodes.md): The nine node kinds, node structure, the bilateral contract model, and the node manifest.
- [Packets](https://flowdsl.com/raw/docs/concepts/packets.md): Packets are the typed data schemas for data flowing along edges in FlowDSL.
- [Retry Policies](https://flowdsl.com/raw/docs/concepts/retry-policies.md): Configure automatic retry behavior for failed edge deliveries in FlowDSL.
- [What is FlowDSL?](https://flowdsl.com/raw/docs/concepts/what-is-flowdsl.md): FlowDSL as a specification, where it fits in the API ecosystem, and the four layers of a FlowDSL system.
- [Delivery Modes](https://flowdsl.com/raw/docs/delivery-modes.md): Direct, ephemeral, checkpoint, durable, stream — when to use each.
- [Getting Started](https://flowdsl.com/raw/docs/getting-started.md): Write your first FlowDSL flow in 5 minutes.
- [AsyncAPI ↔ FlowDSL Integration](https://flowdsl.com/raw/docs/guides/asyncapi-integration.md): Full guide to referencing AsyncAPI event contracts in FlowDSL, including schema evolution and breaking change handling.
- [How to Choose the Right Delivery Mode](https://flowdsl.com/raw/docs/guides/choosing-delivery-modes.md): A practical decision guide for selecting the right delivery mode for each edge in your FlowDSL flows.
- [Error Handling, Dead Letters, and Recovery](https://flowdsl.com/raw/docs/guides/error-handling.md): How FlowDSL handles failures at every level — node errors, delivery failures, dead letters, and manual recovery.
- [High-Throughput Pipelines](https://flowdsl.com/raw/docs/guides/high-throughput-pipelines.md): Batching, checkpoint tuning, parallelism, and performance targets for high-volume FlowDSL flows.
- [Writing Idempotent Nodes](https://flowdsl.com/raw/docs/guides/idempotency.md): How to make FlowDSL nodes safe to retry and replay using idempotency keys and deduplication patterns.
- [Guides](https://flowdsl.com/raw/docs/guides.md): Practical guides for common FlowDSL patterns, decisions, and integrations.
- [Building AI Agent Flows with FlowDSL](https://flowdsl.com/raw/docs/guides/llm-flows.md): Orchestrate LLM pipelines with reliable delivery semantics, idempotency, and cost control using FlowDSL.
- [Building and Publishing FlowDSL Nodes](https://flowdsl.com/raw/docs/guides/node-development.md): How to develop, test, version, and publish FlowDSL nodes to the node registry.
- [Using Redelay as the FlowDSL Backend](https://flowdsl.com/raw/docs/guides/redelay-integration.md): Integrate FlowDSL with redelay for Python/FastAPI event-driven workflows with automatic AsyncAPI generation.
- [Stateful Workflows vs Streaming Pipelines](https://flowdsl.com/raw/docs/guides/stateful-vs-streaming.md): Two fundamental workload classes in FlowDSL and how to design each.
- [Welcome to FlowDSL](https://flowdsl.com/raw/docs.md): FlowDSL is the open domain-specific language (DSL) for describing executable event-driven flow graphs. Define flows, nodes, edges and delivery semantics in one document. Sibling to OpenAPI and AsyncAPI.
- [Migration](https://flowdsl.com/raw/docs/migration.md): Version history, breaking changes, and migration guides for the FlowDSL specification and tooling.
- [Communication Protocols](https://flowdsl.com/raw/docs/reference/grpc-protocol.md): All communication protocols supported by FlowDSL — gRPC, HTTP, NATS, Kafka, Redis, ZeroMQ, RabbitMQ, and WebSockets.
- [Reference](https://flowdsl.com/raw/docs/reference.md): Complete field-by-field reference documentation for the FlowDSL specification.
- [Node Manifest Reference](https://flowdsl.com/raw/docs/reference/node-manifest.md): Complete field reference for the flowdsl-node.json node manifest format — identity, runtime, ports, settingsSchema, and publishing.
- [Node Registry API Reference](https://flowdsl.com/raw/docs/reference/node-registry-api.md): REST API reference for the repo.flowdsl.com node registry.
- [Components Reference](https://flowdsl.com/raw/docs/reference/spec/components.md): The components section of a FlowDSL document — packets, events, policies, and node templates.
- [DeliveryPolicy Reference](https://flowdsl.com/raw/docs/reference/spec/delivery-policy.md): Complete field-by-field reference for the FlowDSL DeliveryPolicy object.
- [Edge Object Reference](https://flowdsl.com/raw/docs/reference/spec/edge.md): Complete field reference for the Edge object in FlowDSL.
- [Extensions (x-*) Reference](https://flowdsl.com/raw/docs/reference/spec/extensions.md): Extension fields for tooling hints, metadata, and custom behavior in FlowDSL documents.
- [Flow Object Reference](https://flowdsl.com/raw/docs/reference/spec/flow.md): Flow-level fields and structure in a FlowDSL document.
- [FlowDSL Document Reference](https://flowdsl.com/raw/docs/reference/spec/flowdsl-document.md): Top-level fields of a FlowDSL document.
- [Node Object Reference](https://flowdsl.com/raw/docs/reference/spec/node.md): Complete field reference for the Node object in FlowDSL.
- [Packets Reference](https://flowdsl.com/raw/docs/reference/spec/packets.md): Packet schema format, reference syntax, and validation in FlowDSL.
- [RetryPolicy Reference](https://flowdsl.com/raw/docs/reference/spec/retry-policy.md): Complete field reference for the RetryPolicy object in FlowDSL.
- [Runtime Bindings Reference](https://flowdsl.com/raw/docs/reference/spec/runtime-bindings.md): The x-runtime extension for binding FlowDSL delivery modes to specific infrastructure.
- [CLI Tools](https://flowdsl.com/raw/docs/tools/cli.md): Command-line tools for validating, formatting, and working with FlowDSL documents.
- [Go SDK Reference](https://flowdsl.com/raw/docs/tools/go-sdk.md): Reference for the flowdsl-go SDK — implementing and running FlowDSL nodes in Go.
- [Tools](https://flowdsl.com/raw/docs/tools.md): Official FlowDSL tools — Studio, CLI, and language SDKs.
- [JavaScript SDK Reference](https://flowdsl.com/raw/docs/tools/js-sdk.md): Reference for the @flowdsl/sdk — implementing FlowDSL nodes in TypeScript and Node.js.
- [Python SDK Reference](https://flowdsl.com/raw/docs/tools/python-sdk.md): Reference for the flowdsl-py SDK — implementing FlowDSL nodes in async Python.
- [FlowDSL Studio](https://flowdsl.com/raw/docs/tools/studio.md): Feature reference for the FlowDSL visual editor.
- [Reference AsyncAPI Messages in FlowDSL](https://flowdsl.com/raw/docs/tutorials/connecting-asyncapi.md): Use existing AsyncAPI event contracts as packet types in your FlowDSL flows without duplicating schemas.
- [Run FlowDSL Locally with Docker Compose](https://flowdsl.com/raw/docs/tutorials/docker-compose-local.md): Start the full FlowDSL infrastructure stack on your machine using Docker Compose.
- [Build an Email Triage Workflow](https://flowdsl.com/raw/docs/tutorials/email-triage-flow.md): Build a stateful LLM-powered email classification and routing workflow with idempotency and retry policies.
- [Getting Started with FlowDSL](https://flowdsl.com/raw/docs/tutorials/getting-started.md): Run your first FlowDSL flow in 5 minutes using the Order Fulfillment example in Studio.
- [Tutorials](https://flowdsl.com/raw/docs/tutorials.md): Step-by-step tutorials for building FlowDSL flows and nodes.
- [Build a Sales Pipeline Flow](https://flowdsl.com/raw/docs/tutorials/sales-pipeline-flow.md): Build a CRM-style lead enrichment, scoring, and routing flow with LLM intelligence.
- [Using FlowDSL Studio](https://flowdsl.com/raw/docs/tutorials/using-the-studio.md): A complete walkthrough of the FlowDSL visual editor — canvas, nodes, edges, validation, and export.
- [Write a FlowDSL Node in Go](https://flowdsl.com/raw/docs/tutorials/writing-a-go-node.md): Implement, register, and test a FlowDSL FilterNode using the flowdsl-go SDK.
- [Write a FlowDSL Node in Python](https://flowdsl.com/raw/docs/tutorials/writing-a-python-node.md): Implement, register, and test an LlmAnalyzer node using the flowdsl-py SDK.
- [Build Your First FlowDSL Flow](https://flowdsl.com/raw/docs/tutorials/your-first-flow.md): Build a webhook-to-Slack routing flow from scratch, step by step.