https://github.com/flowsynx/flowsynx
A declarative, unified interoperability compositional substrate enabling intelligent information flow across diverse environments—from legacy systems to modern cloud ecosystems—delivering secure, reliable, auditable, and fully controllable orchestration for the hybrid enterprise.
https://github.com/flowsynx/flowsynx
ai-workflow cross-platform csharp dag data-pipeline declarative-workflows directed-acyclic-graph docker dotnet dotnet-core flowsynx plugin-architecture task-scheduler workflow workflow-automation workflow-engine workflow-orchestration workflows
Last synced: 4 months ago
JSON representation
A declarative, unified interoperability compositional substrate enabling intelligent information flow across diverse environments—from legacy systems to modern cloud ecosystems—delivering secure, reliable, auditable, and fully controllable orchestration for the hybrid enterprise.
- Host: GitHub
- URL: https://github.com/flowsynx/flowsynx
- Owner: flowsynx
- License: mit
- Created: 2023-11-04T14:47:26.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2026-01-04T16:05:43.000Z (4 months ago)
- Last Synced: 2026-01-04T19:28:01.317Z (4 months ago)
- Topics: ai-workflow, cross-platform, csharp, dag, data-pipeline, declarative-workflows, directed-acyclic-graph, docker, dotnet, dotnet-core, flowsynx, plugin-architecture, task-scheduler, workflow, workflow-automation, workflow-engine, workflow-orchestration, workflows
- Language: C#
- Homepage: https://flowsynx.io
- Size: 6.61 MB
- Stars: 40
- Watchers: 1
- Forks: 26
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Roadmap: docs/ROADMAP.md
Awesome Lists containing this project
README
The Open Unified Compositional Substrate for Intelligent Information Flow
A declarative, source-agnostic platform providing a composable foundation for AI-driven workflows,
human-in-the-loop decision support, and limitless plugin extensibility. Secure, reliable, and transparent
across any environment.
[![dotnet][dotnet-budge]][dotnet-url]
[![Codacy Badge][codacy-badge]][codacy-url]
[![Quality Gate Status][sonarcloud-quality-gate-badge]][sonarcloud-quality-gate-url]
[![License: MIT][mit-badge]][mit-url]
[![Build Status][actions-badge]][actions-url]
[![FOSSA Status][fossa-badge]][fossa-url]
[![Good First Issues][github-good-first-issue-badge]][github-good-first-issue-url]
> [](https://github.com/flowsynx/flowsynx)
> ✨ **Support FlowSynx by giving it a star!** ✨
> Your support helps others discover the project and drives continued innovation.
FlowSynx is a **declarative, unified platform** designed to enable **intelligent information flow**
across any system, process, or service. With **Source-Agnostic Processing** and a **plugin-driven architecture**,
it provides infinite extensibility, letting teams automate operations seamlessly across **on-premises**, **cloud**,
and **hybrid** environments.
By defining processes in **JSON** and leveraging a rich plugin ecosystem, FlowSynx makes automation truly
universal — from **DevOps pipelines** and **AI integrations** to complex **enterprise data operations**.
Its design ensures **flexibility**, **scalability**, and **visibility**, giving teams full control over **operations,
data pipelines**, and **mission-critical tasks**.
With FlowSynx, you can unify automation, extend capabilities endlessly, and orchestrate **intelligent flows**
that adapt to any environment or technology stack.
### 💬 Share FlowSynx
Help grow the community by sharing FlowSynx with your network:
**[Share on X (Twitter)](https://x.com/intent/tweet?text=Check%20out%20this%20awesome%20project%20on%20GitHub!%20⭐%0Ahttps%3A%2F%2Fgithub.com%2Fflowsynx%2Fflowsynx)**
**[Share on LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fgithub.com%2Fflowsynx%2Fflowsynx)**
Or copy and share this snippet:
```text
⭐ Check out FlowSynx — an open-source automation fabric for orchestrating anything, anywhere:
https://github.com/flowsynx/flowsynx
```
## Table of Contents
- [What is FlowSynx?](#what-is-flowsynx)
- [How It Works](#how-it-works)
- [Core Concepts](#core-concepts)
- [Task Lifecycle](#task-lifecycle)
- [Execution Modes](#execution-modes)
- [Runtime Context](#runtime-context)
- [Why FlowSynx?](#why-flowsynx)
- [Differentiate & Articulate Uniquely](#differentiate--articulate-uniquely)
- [Key Features](#key-features)
- [Roadmap](#roadmap)
- [Quick Start Experience](#quick-start-experience)
- [Build from Source](#build-from-source)
- [Architecture Overview](#architecture-overview)
- [Interaction Layers](#interaction-layers)
- [Core Components](#core-components)
- [Environments](#environments)
- [User Interfaces](#user-interfaces)
- [FlowCtl (CLI)](#flowctl-cli)
- [Web Console](#web-console)
- [Related Repositories](#related-repositories)
- [Community & Contributing](#community--contributing)
- [Security](#security)
- [License](#license)
## What is FlowSynx?
In today’s fast-moving software landscape, teams need **repeatable**, **modular**, and **secure** automation — without being locked into rigid platforms.
**FlowSynx** redefines orchestration with:
- A **.NET-based micro-kernel engine** built for performance and reliability
- A **plugin-driven architecture** that evolves with your needs
- A **JSON-based DAG (Directed Acyclic Graph)** workflow model that’s both human-readable and machine-friendly
FlowSynx transforms your processes — from data management to API and ML/AI automation — into **clear, maintainable, and reusable workflows**.
## How It Works
At its core, FlowSynx executes **DAG-based workflows** where each task represents an atomic operation — reading data, transforming it, sending HTTP requests, or interacting with external systems.
### Core Concepts
- **Workflow JSON** — Define tasks, dependencies, and parameters in simple JSON
- **Plugins** — Modular building blocks for any functionality (file I/O, APIs, cloud storage, data transformation, ML/AI, etc.)
- **Execution Engine** — Smart orchestration with:
- Dependency resolution (topological sorting)
- Shared execution context and secure state handling
- Asynchronous execution, retries, and timeouts
- Built-in logging, metrics, and auditing
## Task Lifecycle
Every task flows through a predictable, reliable lifecycle:
1. **Initialization** – Validates plugin and parameters
2. **Dependency Wait** – Ensures prerequisite tasks are complete
3. **Execution** – Runs the plugin logic (e.g., `ReadAsync`, `WriteAsync`)
4. **Error Handling** – Retries, fallbacks, or workflow failover
5. **Post-Processing** – Logs, stores outputs, and passes results downstream
## Execution Modes
Choose how you run FlowSynx — on your terms:
| Mode | Description |
|------|--------------|
| **Standalone** | Lightweight binary for local or embedded use |
| **Dockerized** | Ready for CI/CD pipelines and Kubernetes clusters |
| **API Mode** | Trigger workflows via REST APIs |
| **CLI (`flowctl`)** | Command-line power for developers |
## Runtime Context
- Shared Variables
- Secure Secrets Management
- Plugin Buffers & Metadata
- Real-Time State Tracking
## Why FlowSynx?
Modern automation is complex — but it doesn’t have to be **complicated**.
FlowSynx is designed to:
- **Empower developers** with modularity and openness
- **Simplify operations** through declarative configuration
- **Bridge teams** across development, data, and business processes
- **Scale effortlessly** across environments
Built on clean architecture principles, FlowSynx provides **clarity**, **control**, and **confidence** — even in the most demanding automation scenarios.
## Differentiate & Articulate Uniquely
There are countless workflow and orchestration engines on the market — but FlowSynx stands apart by focusing on flexibility, developer empowerment, and true portability.
Here’s what makes FlowSynx unique:
#### 1. NET Native & Plugin-Based
- Built entirely in **.NET**, giving developers seamless integration with the .NET ecosystem.
- **Plugin-first architecture:** add, remove, or update capabilities dynamically. No core modifications required.
- Supports **custom plugins**, enabling anything from cloud storage and APIs to ML/AI tasks.
#### 2. JSON-Defined DAG Workflows
- Workflows are **fully declarative** in JSON — human-readable and machine-friendly.
- DAG execution ensures **reliable dependency handling, asynchronous execution**, and full **observability**.
- Unlike other engines, FlowSynx makes complex workflows **easy to version, maintain, and share**.
#### 3. Human-in-the-Loop Support
- Integrate **approval gates and manual tasks** directly into workflows.
- Automate most of the process while keeping humans in control where needed — ideal for enterprise scenarios.
#### 4. Hybrid, Cross-Platform Execution
- Run **on-premises**, in **containers**, or fully **cloud-native** — no vendor lock-in.
- Lightweight footprint and fast startup for **developer-friendly experimentation**.
- Works everywhere: **Windows, Linux, macOS, Docker, Kubernetes**.
#### 5. Marketplace of Plugins
- Discover, share, and manage pre-built and custom plugins via a central **Marketplace/Registry**.
- Extend capabilities quickly without reinventing the wheel.
#### 6. What Competitors Lack
- Many orchestration tools either:
- Lock you into a proprietary ecosystem,
- Force heavyweight deployments, or
- Lack support for hybrid and human-in-loop workflows.
- FlowSynx solves these gaps **while remaining lightweight, extensible, and fully open-source**.
**Bottom line:** FlowSynx is not just another orchestration engine. It’s a **developer-first, plugin-powered, hybrid automation fabric** that adapts to your environment — not the other way around.
## Key Features
✅ **Plugin-Based Extensibility** — Add, upgrade, or remove capabilities dynamically and version-controlled
✅ **Cross-Platform Execution** — Runs everywhere (Windows, Linux, macOS, Docker, Cloud)
✅ **JSON-Defined Workflows** — Declarative, portable, and version-controlled
✅ **Schema Validation** — Catch errors early with JSON schema checks
✅ **CLI & SDK Support** — Total control for developers and DevOps teams
✅ **Robust Authentication & Access Control** — Compatible with JWT and Basic Auth, featuring RBAC
✅ **Secret Management Integration** — Infisical, Azure Key Vault, HashiCorp Vault, AWS Secrets Manager
✅ **Triggers & Events** — Webhooks, schedules, and file-change detection
✅ **Human-in-the-Loop Tasks** — Combine automation with human approval
✅ **Conditional Flow Control** — Execute tasks based on conditions and branching logic
✅ **Expression Evaluation** — Dynamic parameterization using expressions
✅ **Advanced Logging & Auditing** — Full transparency into every execution
✅ **Error Handling** - Configurable Error Handling and Retry Policies per task and workflow level
✅ **Marketplace & Registry** — Discover and manage plugins easily
✅ **Web Console UI** — Intuitive dashboard for workflow monitoring and control
✅ **Unified Data Abstraction Layer (UDAL)** — Simplifies data access across diverse sources
✅ **Source-Agnostic Processing** — Operate uniformly and interchangeably, regardless of the original data source or protocol
## Roadmap
Curious about what’s next? Review the planned milestones in our [Roadmap](./docs/ROADMAP.md).
## Quick Start Experience
Get up and running with FlowSynx in 5 minutes — no complex setup required.
👉 [FlowSynx in 5 Minutes (Quickstart)](https://flowsynx.io/docs/getting-started/quickstarts/flowsynx-in-5-minutes)
### Option 1 — Run via Docker (Recommended)
If Docker is already installed on your system, you can start FlowSynx immediately using a simple Docker command.
Just copy and paste the following into your terminal:
```bash
docker run -d --name flowsynx -p 6262:6262 -v flowsynx_data:/app/data flowsynx/flowsynx:1.2.4-linux-amd64 --start
```
**This will:**
- Start FlowSynx
- Automatically configure admin credentials (admin / admin)
- Expose the FlowSynx API at `http://localhost:6262` (local-only access)
Verify it's running:
```bash
curl http://localhost:6262/version
```
### Option 2 — Use a Pre-Built Binary
Prefer to run FlowSynx locally?
Download a pre-built binary for your OS from the latest release:
👉 [**Download FlowSynx Releases**](https://github.com/flowsynx/flowsynx/releases/latest)
Then run:
```bash
flowsynx --start
```
## Build from Source
Want to contribute or customize FlowSynx?
You can build it locally in just a few commands.
### Prerequisites
- [.NET 10 SDK](https://dotnet.microsoft.com/download/dotnet/10.0) — verify with `dotnet --version` (should report 10.x)
- Git
### Local Build
```bash
git clone https://github.com/flowsynx/flowsynx
cd flowsynx
dotnet restore
dotnet build --configuration Release
dotnet test
```
- Works seamlessly on **Windows**, **Linux**, and **macOS**.
- Build outputs are placed in each project’s `bin/Release` directory.
## Hello Workflow Example
Once FlowSynx is running (via Docker or binary), try creating and executing your first workflow using the REST API.
### 1️⃣ Add a Workflow
Call this api:
```bash
curl -u admin:admin -X POST http://localhost:6262/workflows \
-H "Content-Type: application/json" \
-d '
{
"name": "Hello Workflow",
"description": "A minimal FlowSynx workflow example",
"tasks": [
{
"name": "print_hello",
"type": "",
"parameters": {
"operation": "write",
"path": "results/test.txt",
"data": "Hello, FlowSynx!",
"overwrite": false
}
}
]
}
'
```
### Example response
```json
{
"data": {
"id": "",
"name": "Hello Workflow"
},
"messages": [
"The workflow has been added successfully."
],
"succeeded": true,
"generatedAtUtc": "2025-11-04T14:40:27Z"
}
```
📘 Note: Keep the value — you’ll need it to run the workflow.
### 2️⃣ Execute the Workflow
```bash
curl -u admin:admin -X POST http://localhost:6262/workflows//executions
```
### 3️⃣ Verify Output
After execution, check the file `results/test.txt`
inside the FlowSynx container or on your host system — you should see:
```
Hello, FlowSynx!
```
For advanced workflows, Docker setup:
📘 **Documentation:** [Getting Started Guide](https://flowsynx.io/docs/getting-started)
🧩 **Samples:** [Example Workflows & Configs](https://github.com/flowsynx/samples)
## Architecture Overview
### Interaction Layers
- **CLI (FlowCtl)** — Lightweight command-line orchestration
- **REST API Gateway** — Secure, API-first automation
- **SDKs & Libraries** — Integrate FlowSynx into your own apps
### Core Components
- **Workflow Orchestrator** — Executes and manages JSON-defined DAGs
- **Plugin Manager** — Loads and maintains plugins dynamically
- **Security & Auth Layer** — Ensures safe access and execution
- **Logging & Auditing Engine** — Observability built in
- **Trigger Engine** — React to events, schedules, and external signals
### Environments
Deploy FlowSynx locally, in containers, or cloud-native — with complete portability.
## User Interfaces
### FlowCtl (CLI)
Powerful, scriptable, and developer-friendly.
### Web Console
A clean, interactive dashboard for:
- Workflow management
- Real-time monitoring
- Execution logs and metrics
- Human task approvals
## Related Repositories
| Repository | Description |
|-------------|-------------|
| [**FlowSynx**](https://github.com/flowsynx/flowsynx) | Core engine and runtime for executing JSON-based DAG workflows with plugin-based orchestration. |
| [**FlowCtl**](https://github.com/flowsynx/flowctl) | Command-line tool for initializing, running, and managing FlowSynx workflows. |
| [**Console**](https://github.com/flowsynx/console) | Web-based dashboard for managing, monitoring, and visualizing workflows. |
| [**Docs**](https://flowsynx.io/docs/overview) | Official documentation with setup guides, examples, and API references. |
| [**Samples**](https://github.com/flowsynx/samples) | Ready-to-run example workflows and configuration templates. |
| [**Plugin Core**](https://github.com/flowsynx/plugin-core) | SDK and interfaces for building custom FlowSynx plugins. |
| [**FlowPack**](https://github.com/flowsynx/flowpack) | CLI tool to package and publish FlowSynx plugins as `.fspack` bundles. |
| [**C# SDK**](https://github.com/flowsynx/csharp-sdk) | .NET SDK for integrating and controlling FlowSynx programmatically. |
| [**Plugin Marketplace**](https://github.com/flowsynx/plugin-registry) | Central hub to discover, publish, and manage FlowSynx plugins. |
| [**Plugin Template**](https://github.com/flowsynx/plugin-template-project) | .NET project template for creating new FlowSynx plugins quickly. |
## Community & Contributing
Join our growing community of developers and automation experts.
You can:
- 💡 Submit ideas and feature requests
- 🔌 Build and publish plugins
- 🧱 Contribute to the core or documentation
- 🌍 Collaborate in discussions
- 🤝 Review the [Code of Conduct](./CODE_OF_CONDUCT.md) to help keep the community welcoming
👉 See [CONTRIBUTING.md](https://github.com/flowsynx/flowsynx/blob/master/CONTRIBUTING.md)
## Communication and Discord
We’d love your contributions and feedback!
Join our community and discussions on Discord or follow us on X (Twitter):
| Platform | Link |
|-----------|------|
| **Discord (preferred)** | [Discord](https://discord.gg/KJwtjkv7Rj) |
| **X (Twitter)** | [@flowsynxio](https://x.com/flowsynxio) |
## Security
We take the security of FlowSynx seriously.
If you discover a vulnerability, please review our [Security Policy](./SECURITY.md) for responsible disclosure guidelines.
Thank you for helping us keep the community safe!
## License
FlowSynx is open-source and licensed under the **MIT License**.
See [LICENSE](https://github.com/flowsynx/flowsynx/blob/master/LICENSE) for details.
[mit-badge]: https://img.shields.io/github/license/flowsynx/flowsynx?style=flat&label=License&logo=github
[mit-url]: https://github.com/flowsynx/flowsynx/blob/master/LICENSE
[actions-badge]: https://github.com/flowsynx/flowsynx/actions/workflows/flowsynx-release.yml/badge.svg?branch=master
[actions-url]: https://github.com/flowsynx/flowsynx/actions?workflow=flowsynx
[fossa-badge]: https://app.fossa.com/api/projects/git%2Bgithub.com%2Fflowsynx%2Fflowsynx.svg?type=shield&issueType=license
[fossa-url]: https://app.fossa.com/projects/git%2Bgithub.com%2Fflowsynx%2Fflowsynx?ref=badge_shield&issueType=license
[codacy-badge]: https://app.codacy.com/project/badge/Grade/cc8cc16dbade4f5b93b82fd29ed7c879
[codacy-url]: https://app.codacy.com/gh/flowsynx/flowsynx/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
[github-good-first-issue-badge]: https://img.shields.io/github/issues/flowsynx/flowsynx/good%20first%20issue?style=flat-square&logo=github&label=good%20first%20issues
[github-good-first-issue-url]: https://github.com/flowsynx/flowsynx/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
[sonarcloud-quality-gate-badge]: https://sonarcloud.io/api/project_badges/measure?project=flowsynx_flowsynx&metric=alert_status
[sonarcloud-quality-gate-url]: https://sonarcloud.io/summary/new_code?id=flowsynx_flowsynx
[dotnet-budge]: https://img.shields.io/badge/.NET-10.0-green
[dotnet-url]: https://dotnet.microsoft.com/en-us/download/dotnet/10.0