User manual overview
FlowO is a command center for Snakemake runs: one browser app for live status, history, logs, outputs, and optional catalog templates.
Primary UI areas
| Area | Route (typical) | Role |
|---|---|---|
| Runs | /runs |
Searchable list of executions (name, tags, status, progress, catalog link). |
| Run detail | /runs/{id} |
DAG, jobs table, timeline, captured code, and result previews for one execution. |
| Dashboard | /dashboard |
Fleet-wide aggregates: status mix, activity, rule errors, resources (when enabled). |
| Catalog | /catalog |
Template library: files in DB, DAG preview, recent runs linked to each entry. |
| Settings | /settings |
Profile, API tokens, MCP, SMTP, Git—most items are optional beyond basic use. |
How pieces connect
- You run
snakemake --logger flowo …on a machine with network access to the FlowO API. - Events land in PostgreSQL; the UI learns about updates through SSE.
- For previews, the FlowO server must see the same filesystem tree (via
FLOWO_WORKING_PATH) that Snakemake used when it reported paths.
Chapters in this manual
- Installation
- Login and CLI setup
- Run Snakemake with FlowO
- Dashboard
- Runs and workflow detail
- Jobs, logs, and errors
- Results preview
- Catalog and templates
- DAG preview
For optional AI and email capabilities, see Advanced features in the site navigation.