Run Flowpipe

Flowpipe is simple to install and manage and does not require any special expertise to get started. It's distributed as a single binary file - just download and run it!

Mod Location

Flowpipe always runs in the context of a mod, which is a collection of Flowpipe pipelines and triggers. You can import and use resources from other mods so you can get started without even writing any code! You can explore the available mods on the Flowpipe Hub.

Flowpipe loads the mod from the current directory by default, but you can pass the --mod-location flag or set the FLOWPIPE_MOD_LOCATION to set it to a different path. The event store is also written to this mod location, in the .flowpipe/store/ subdirectory.

Configuration Files

Flowpipe will load configuration files (*.fpc) according to the configuration search path. You can change this path with the --config-path argument or the FLOWPIPE_CONFIG_PATH environment variable, but it defaults to .:$FLOWPIPE_INSTALL_DIR/config (.:~/.flowpipe/config). This allows you to manage your workspaces and credentials centrally in the ~/.flowpipe/config directory, but override them in the working directory / mod location if desired.

Operating Modes

Flowpipe can operate in 2 modes.

By default, Flowpipe runs in Client-only Mode. Flowpipe loads the mod, runs the command, and exits. Triggers are not enabled in Client-Only Mode.

If you run Flowpipe in Server Mode mode, Flowpipe will run an API server (on port 7103 by default). In this mode, you can create triggers that run pipelines on a schedule or in response to events such as webhooks. After you start the Flowpipe server, you can run Flowpipe commands against it by specifying the --host argument.