|
| 1 | +# Flow |
| 2 | + |
| 3 | +> Flow is a local-first automation platform that helps you organize and execute any kind of workflow through declarative YAML. It provides a CLI, an interactive TUI, secret management via vaults, templating for code generation, and an MCP server for AI-agent integration. |
| 4 | + |
| 5 | +Flow organizes automation into **workspaces** (projects/domains), each rooted at a `flow.yaml` config file. Inside a workspace, **executables** are declared in `*.flow` (or `*.flow.yaml`) files and run by invoking a **verb** (e.g. `run`, `build`, `test`, `deploy`) optionally combined with a `workspace/namespace:name` reference. Executables can be simple commands, HTTP requests, or orchestrated serial/parallel pipelines. **Templates** (`*.flow.tmpl`) generate new workflows interactively. |
| 6 | + |
| 7 | +## Getting Started |
| 8 | + |
| 9 | +- [Home](https://flowexec.io/): Landing page with feature overview |
| 10 | +- [Installation](https://flowexec.io/installation): Install flow on macOS, Linux, or Windows |
| 11 | +- [Quick Start](https://flowexec.io/quickstart): Five-minute walkthrough from install to first executable |
| 12 | + |
| 13 | +## Core Guides |
| 14 | + |
| 15 | +- [Guides Overview](https://flowexec.io/guides/): Index of all user guides |
| 16 | +- [Concepts](https://flowexec.io/guides/concepts): Executables, verbs, workspaces, namespaces, templates, vaults, execution model |
| 17 | +- [Your First Workflow](https://flowexec.io/guides/first-workflow): End-to-end tutorial for building a workflow |
| 18 | +- [Executables](https://flowexec.io/guides/executables): Full reference for executable types (exec, serial, parallel, request, launch, render) |
| 19 | +- [Workspaces](https://flowexec.io/guides/workspaces): How workspaces organize projects and domains |
| 20 | +- [Secrets](https://flowexec.io/guides/secrets): Vault-backed secret storage and injection into executions |
| 21 | +- [Execution History & Logs](https://flowexec.io/guides/execution-history): Viewing, attaching to, and inspecting past runs |
| 22 | + |
| 23 | +## Advanced |
| 24 | + |
| 25 | +- [Imported Executables](https://flowexec.io/guides/generated-config): Auto-import from Makefile, package.json, docker-compose, shell scripts |
| 26 | +- [Templates & Workflow Generation](https://flowexec.io/guides/templating): Generate executables from templates with interactive forms |
| 27 | +- [Advanced Workflows](https://flowexec.io/guides/advanced): Serial/parallel pipelines, retries, conditional execution, arguments/params |
| 28 | +- [Interactive UI](https://flowexec.io/guides/interactive): TUI customization and keybindings |
| 29 | +- [Integrations](https://flowexec.io/guides/integrations): MCP server, GitHub Actions, Docker, CI pipelines |
| 30 | + |
| 31 | +## Configuration Reference |
| 32 | + |
| 33 | +- [Config Reference Overview](https://flowexec.io/types/): Index with direct JSON schema links |
| 34 | +- [FlowFile Schema](https://flowexec.io/types/flowfile): Structure of `*.flow` / `*.flow.yaml` files |
| 35 | +- [Workspace Schema](https://flowexec.io/types/workspace): Structure of `flow.yaml` workspace config |
| 36 | +- [Template Schema](https://flowexec.io/types/template): Structure of `*.flow.tmpl` template files |
| 37 | +- [Config Schema](https://flowexec.io/types/config): Structure of the user-level flow config |
| 38 | + |
| 39 | +## JSON Schemas |
| 40 | + |
| 41 | +- [flowfile_schema.json](https://flowexec.io/schemas/flowfile_schema.json): Use this to validate or generate `*.flow` files |
| 42 | +- [workspace_schema.json](https://flowexec.io/schemas/workspace_schema.json): Use this to validate or generate `flow.yaml` files |
| 43 | +- [template_schema.json](https://flowexec.io/schemas/template_schema.json): Use this to validate or generate `*.flow.tmpl` files |
| 44 | +- [config_schema.json](https://flowexec.io/schemas/config_schema.json): Use this to validate or generate the user-level config |
| 45 | + |
| 46 | +## CLI Reference |
| 47 | + |
| 48 | +- [CLI Overview](https://flowexec.io/cli/flow): Top-level `flow` command and global flags |
| 49 | +- [flow browse](https://flowexec.io/cli/flow_browse): Interactive TUI for discovering and running executables |
| 50 | +- [flow exec](https://flowexec.io/cli/flow_exec): Run an executable directly |
| 51 | +- [flow sync](https://flowexec.io/cli/flow_sync): Refresh cached executable and workspace state |
| 52 | +- [flow mcp](https://flowexec.io/cli/flow_mcp): Start the MCP server over stdio for AI-agent integration |
| 53 | + |
| 54 | +### Logs |
| 55 | + |
| 56 | +- [flow logs](https://flowexec.io/cli/flow_logs): View execution history |
| 57 | +- [flow logs attach](https://flowexec.io/cli/flow_logs_attach): Attach to a running background execution |
| 58 | +- [flow logs clear](https://flowexec.io/cli/flow_logs_clear): Clear log history |
| 59 | +- [flow logs kill](https://flowexec.io/cli/flow_logs_kill): Terminate a background execution |
| 60 | + |
| 61 | +### Cache |
| 62 | + |
| 63 | +- [flow cache](https://flowexec.io/cli/flow_cache): Manage cached executable metadata |
| 64 | +- [flow cache clear](https://flowexec.io/cli/flow_cache_clear): Clear all cache entries |
| 65 | +- [flow cache get](https://flowexec.io/cli/flow_cache_get): Read a specific cache entry |
| 66 | +- [flow cache list](https://flowexec.io/cli/flow_cache_list): List cache entries |
| 67 | +- [flow cache remove](https://flowexec.io/cli/flow_cache_remove): Remove a specific entry |
| 68 | +- [flow cache set](https://flowexec.io/cli/flow_cache_set): Write a cache entry |
| 69 | + |
| 70 | +### Config |
| 71 | + |
| 72 | +- [flow config](https://flowexec.io/cli/flow_config): User-level configuration commands |
| 73 | +- [flow config get](https://flowexec.io/cli/flow_config_get): Read current config |
| 74 | +- [flow config reset](https://flowexec.io/cli/flow_config_reset): Reset to defaults |
| 75 | +- [flow config set](https://flowexec.io/cli/flow_config_set): Update a config value |
| 76 | +- [flow config set namespace](https://flowexec.io/cli/flow_config_set_namespace): Set current namespace |
| 77 | +- [flow config set workspace](https://flowexec.io/cli/flow_config_set_workspace): Set current workspace |
| 78 | +- [flow config set workspace-mode](https://flowexec.io/cli/flow_config_set_workspace-mode): Set fixed vs dynamic workspace mode |
| 79 | +- [flow config set log-mode](https://flowexec.io/cli/flow_config_set_log-mode): Set default log output format |
| 80 | +- [flow config set timeout](https://flowexec.io/cli/flow_config_set_timeout): Set default execution timeout |
| 81 | +- [flow config set theme](https://flowexec.io/cli/flow_config_set_theme): Customize TUI theme |
| 82 | +- [flow config set tui](https://flowexec.io/cli/flow_config_set_tui): Toggle interactive mode defaults |
| 83 | +- [flow config set notifications](https://flowexec.io/cli/flow_config_set_notifications): Configure notification behavior |
| 84 | + |
| 85 | +### Secrets & Vaults |
| 86 | + |
| 87 | +- [flow secret](https://flowexec.io/cli/flow_secret): Manage secrets in the active vault |
| 88 | +- [flow secret get](https://flowexec.io/cli/flow_secret_get): Read a secret value |
| 89 | +- [flow secret list](https://flowexec.io/cli/flow_secret_list): List secrets |
| 90 | +- [flow secret remove](https://flowexec.io/cli/flow_secret_remove): Delete a secret |
| 91 | +- [flow secret set](https://flowexec.io/cli/flow_secret_set): Store a secret |
| 92 | +- [flow vault](https://flowexec.io/cli/flow_vault): Manage vaults |
| 93 | +- [flow vault create](https://flowexec.io/cli/flow_vault_create): Create a new vault (AES256, Age, Keyring, or unencrypted) |
| 94 | +- [flow vault edit](https://flowexec.io/cli/flow_vault_edit): Edit vault metadata |
| 95 | +- [flow vault get](https://flowexec.io/cli/flow_vault_get): Show vault details |
| 96 | +- [flow vault list](https://flowexec.io/cli/flow_vault_list): List registered vaults |
| 97 | +- [flow vault remove](https://flowexec.io/cli/flow_vault_remove): Remove a vault |
| 98 | +- [flow vault switch](https://flowexec.io/cli/flow_vault_switch): Switch active vault |
| 99 | + |
| 100 | +### Templates |
| 101 | + |
| 102 | +- [flow template](https://flowexec.io/cli/flow_template): Manage workflow templates |
| 103 | +- [flow template add](https://flowexec.io/cli/flow_template_add): Register a template |
| 104 | +- [flow template generate](https://flowexec.io/cli/flow_template_generate): Generate a workflow from a template |
| 105 | +- [flow template get](https://flowexec.io/cli/flow_template_get): Show template metadata |
| 106 | +- [flow template list](https://flowexec.io/cli/flow_template_list): List registered templates |
| 107 | + |
| 108 | +### Workspaces |
| 109 | + |
| 110 | +- [flow workspace](https://flowexec.io/cli/flow_workspace): Workspace management commands |
| 111 | +- [flow workspace add](https://flowexec.io/cli/flow_workspace_add): Register a workspace |
| 112 | +- [flow workspace get](https://flowexec.io/cli/flow_workspace_get): Show workspace details |
| 113 | +- [flow workspace list](https://flowexec.io/cli/flow_workspace_list): List registered workspaces |
| 114 | +- [flow workspace remove](https://flowexec.io/cli/flow_workspace_remove): Unregister a workspace |
| 115 | +- [flow workspace switch](https://flowexec.io/cli/flow_workspace_switch): Change active workspace |
| 116 | +- [flow workspace view](https://flowexec.io/cli/flow_workspace_view): Open workspace in TUI |
| 117 | + |
| 118 | +## Optional |
| 119 | + |
| 120 | +- [Contributing](https://flowexec.io/development): Development setup and contribution guide |
| 121 | +- [TUI Kit](https://flowexec.io/tuikit): Companion Bubble Tea-based TUI framework |
| 122 | +- [GitHub Repository](https://github.com/flowexec/flow): Source code, issues, releases |
| 123 | +- [Examples Repository](https://github.com/flowexec/examples): Real-world workflow examples |
| 124 | +- [Discord Community](https://discord.gg/CtByNKNMxM): Community chat |
0 commit comments