cosmoflow 0.4.0

CosmoFlow - A type-safe workflow engine for Rust, inspired by PocketFlow and optimized for LLM applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

# CosmoFlow

A lightweight, type-safe workflow engine for Rust, optimized for LLM applications.

CosmoFlow provides a minimal yet powerful framework for building complex workflows
with clean abstractions and excellent performance. It is:

* **Lightweight**: Minimal dependencies with optional features
* **Type-Safe**: Full Rust type safety with async/await support  
* **LLM-Optimized**: Built-in patterns for AI/LLM workflows
* **Modular**: Enable only what you need through feature flags

[![Crates.io][crates-badge]][crates-url]
[![MIT licensed][mit-badge]][mit-url]
[![Documentation][docs-badge]][docs-url]

[crates-badge]: https://img.shields.io/crates/v/cosmoflow.svg
[crates-url]: https://crates.io/crates/cosmoflow
[mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[mit-url]: https://github.com/echozyr2001/CosmoFlow/blob/main/LICENSE
[docs-badge]: https://docs.rs/cosmoflow/badge.svg
[docs-url]: https://docs.rs/cosmoflow

[Guides](./docs/getting-started.md) |
[API Docs](https://docs.rs/cosmoflow/latest/cosmoflow) |
[Examples](./examples/)

## Overview

**CosmoFlow** is a **next-generation workflow engine** that brings the elegant 
design philosophy of [PocketFlow](https://github.com/The-Pocket/PocketFlow) to 
the Rust ecosystem. Built from the ground up for **LLM applications**, **high-performance scenarios**, 
and **production reliability**. it provides a few major components:

* A lightweight, async-based workflow [scheduler].
* Pluggable storage system (memory, file, Redis).
* Asynchronous [node execution][nodes] with retry logic and error handling.

These components provide the runtime infrastructure necessary for building
complex workflow applications.

[nodes]: https://docs.rs/cosmoflow/latest/cosmoflow/node/index.html
[scheduler]: https://docs.rs/cosmoflow/latest/cosmoflow/flow/index.html

## Quick Start

Add to your `Cargo.toml`:

```toml
[dependencies]
cosmoflow = { version = "0.4.0", features = ["storage-memory"] }
```

Create your first workflow:

```rust
use cosmoflow::prelude::*;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create storage
    let mut store = MemoryStorage::new();
    
    // Build workflow  
    let mut flow = FlowBuilder::new()
        .node("start", MyNode::new())
        .terminal_route("start", "complete")
        .build();
    
    // Execute
    let result = flow.execute(&mut store).await?;
    println!("Workflow completed: {:?}", result);
    Ok(())
}
```

To see a list of the available features flags that can be enabled, check our
[docs][feature-flag-docs].

[feature-flag-docs]: https://docs.rs/cosmoflow/#features

## Getting Help

First, see if the answer to your question can be found in the [Guides] or the
[API documentation]. If the answer is not there, there is an active community in
the [CosmoFlow Discord server][Chat]. We would be happy to try to answer your
question. You can also ask your question on [the discussions page][discussions].

[Guides]: ./docs/getting-started.md
[API documentation]: https://docs.rs/cosmoflow/latest/cosmoflow
[Chat]: https://discord.gg/cosmoflow
[discussions]: https://github.com/echozyr2001/CosmoFlow/discussions

## Core Modules

CosmoFlow provides a focused set of core modules:

* [`cosmoflow`]: Main integration and API crate for CosmoFlow workflows.
* [`cosmoflow::flow`]: Workflow orchestration engine for managing complex multi-node workflows.
* [`cosmoflow::node`]: Execution nodes system with async support and retry logic.
* [`cosmoflow::action`]: Control flow logic and condition evaluation.
* [`cosmoflow::shared_store`]: Thread-safe data communication layer between workflow components.

[`cosmoflow`]: https://docs.rs/cosmoflow/latest/cosmoflow
[`cosmoflow::flow`]: https://docs.rs/cosmoflow/latest/cosmoflow/flow/index.html
[`cosmoflow::node`]: https://docs.rs/cosmoflow/latest/cosmoflow/node/index.html
[`cosmoflow::action`]: https://docs.rs/cosmoflow/latest/cosmoflow/action/index.html
[`cosmoflow::shared_store`]: https://docs.rs/cosmoflow/latest/cosmoflow/shared_store/index.html

## License

This project is licensed under the [MIT license].

[MIT license]: https://github.com/echozyr2001/CosmoFlow/blob/main/LICENSE

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in CosmoFlow by you, shall be licensed as MIT, without any additional
terms or conditions.