Getting Started

Requirements

LightFlow targets Linux for local runtime behavior. Recommended tools:

• Rust stable toolchain
• Bun 1.3+
• Linux shell environment
• optional CortexFS mount at /ctx

Inspect Assets

From the repository root:

cargo run -- assets workflows
cargo run -- assets nodes
cargo run -- assets models

Preview a Run

Preview parses the workflow, validates references, plans CortexFS paths, and renders request templates without writing run state.

cargo run -- run preview workflow.text_plan --id run-001 --inputs '{"prompt":"Write a migration plan"}'

Create and Inspect a Run

cargo run -- run create workflow.text_plan --id run-001 --inputs '{"prompt":"Write a migration plan"}'
cargo run -- run status run-001
cargo run -- run request run-001
cargo run -- run workflow run-001

Run the Docs Site

cd docs-site
bun install
bun run dev

The development server starts at:

http://localhost:3000

Build static output:

cd docs-site
bun run build

Static files are written to:

docs-site/out/

GitHub Pages

The repository includes .github/workflows/docs-pages.yml. On push to main, it installs dependencies with Bun, builds the Nextra site, uploads docs-site/out/, and deploys it to GitHub Pages.

Set Pages source to GitHub Actions in repository settings.