Installation
Flow Studio is a Tauri 2 desktop app. A Rust backend is compiled into a native shell that hosts a React/TypeScript front end. You need both a Rust and a Node toolchain, along with your platform’s native WebView build dependencies.
Core toolchain
Section titled “Core toolchain”| Dependency | Version | Notes |
|---|---|---|
| Rust | 1.77+ (stable) | Install via rustup; edition 2021 |
| Node.js | 20 LTS or newer | Required by Vite and the build scripts |
| pnpm | 10.x | Pinned via packageManager; activate with corepack |
| Tauri CLI | 2.x | Provided through workspace devDependencies, no global install |
Platform dependencies
Section titled “Platform dependencies”xcode-select --installApple Silicon builds enable the Metal GPU backend automatically. You do not need to pass any extra flags.
sudo apt updatesudo apt install -y \ libwebkit2gtk-4.1-dev build-essential curl wget file \ libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-devSee the Tauri prerequisites guide for Fedora and Arch equivalents.
- Install the Microsoft C++ Build Tools with the “Desktop development with C++” workload.
- You also need the WebView2 runtime. It is preinstalled on Windows 11. On Windows 10, install the Evergreen bootstrapper.
Build and run Flow Studio
Section titled “Build and run Flow Studio”-
Activate the pinned pnpm (once per machine):
Terminal window corepack enable && corepack prepare pnpm@10 --activate -
Install the JavaScript workspace dependencies:
Terminal window pnpm install -
Build the Rust workspace (the first build downloads and compiles all crates):
Terminal window cargo build -
Run the desktop app in dev mode with hot reload:
Terminal window pnpm desktop:dev
Production bundles
Section titled “Production bundles”The desktop app builds through Tauri’s bundler. Per-format scripts live at the
workspace root: pnpm desktop:build:dmg / app / macos on macOS,
deb / appimage / linux on Linux, msi / nsis / windows on Windows.
Output lands under apps/frontend/src-tauri/target/release/bundle/<format>/.
Set up local AI
Section titled “Set up local AI”Flow Studio hosts on-device models itself, so nothing leaves the host.
-
Open the Model Hub from the Models icon in the left workspace rail.
-
Download an LLM. Downloads stream with progress and SHA-256 verification.
-
Press Load. The first Load resolves the llama.cpp
llama-serverengine automatically, with no setup on your part. It looks for a previously fetched managed engine, your saved setting, or an engine on$PATH(for example frombrew install llama.cpp). If it finds none of these, it fetches a managed engine for your OS and architecture.
Per-model load settings live in the Model Hub’s Installed detail. These settings include context length, GPU offload layers, threads, flash attention, KV-cache type, and a thinking toggle for reasoning models. GPU use is controlled per model. When you set GPU offload layers above 0, the managed server uses the platform GPU, which is Metal on Apple Silicon and CUDA where available. CPU is always the safe fallback.
Install Flow CLI (headless)
Section titled “Install Flow CLI (headless)”The flow binary runs Flow DSL on the same Rust core, and it does not need the
Node toolchain.
cargo install --path crates/flow-cli
flow # bare command opens the TUIflow ls # saved templatesflow run my-template # run a saved template by slugflow generate "validate a job, then notify on-call if it fails"flow run flow.flow --json # NDJSON event stream for CIThe CLI shares the desktop’s data directory and the OS keyring. The data
directory is ~/.flow-studio/, which you can override with FLOW_STUDIO_DIR.
See the CLI documentation.
Run Flow Server
Section titled “Run Flow Server”The private-cloud edition serves the same UI and engine over HTTP:
cargo run -p flow-server # developmentcargo build -p flow-server --releaseSee Flow Server for deployment, authentication, and the API surface.
Data locations
Section titled “Data locations”User data lives under ~/.flow-studio/. This includes execution history in
SQLite, along with settings, templates, models, and connection metadata.
Secrets such as cloud AI keys and connection passwords live in the OS keyring
only, never on disk. Logs live under ~/.flow-studio/logs/, and they include a
JSON audit line for every shell adapter invocation.