Flowpipe CLI

Sub-Commands

CommandDescription
flowpipe helpHelp about any command
flowpipe integrationList and view integrations
flowpipe modFlowpipe mod management
flowpipe notifierList and view notifiers
flowpipe pipelineList, view, and run Flowpipe pipelines
flowpipe processList and view Flowpipe processes
flowpipe serverRun Flowpipe server, including triggers and integrations
flowpipe triggerList and view Flowpipe triggers
flowpipe variableList and view Flowpipe variables

Global Flags

Flag Description
--config-path Sets the search path for configuration files. This argument accepts a colon-separated list of directories. All configuration files (*.fpc) will be loaded from each path, with decreasing precedence. The default is .:$FLOWPIPE_INSTALL_DIR/config (.:~/.flowpipe/config). This allows you to manage your workspaces and connections centrally in the ~/.flowpipe/config directory, but override them in the working directory / mod location if desired.
--data-dir Sets the event store data directory. Flowpipe defaults to the `.flowpipe` directory in the current mod directory. This argument allows you to specify a different directory.
-h, --help Help for Flowpipe.
--host Run the command against a local or remote server instance. You may specify the full host and port (e.g. --host https://flowpipe.my-org.com:7103), or use the keyword local to connect to the local server instance as a shortcut for https://localhost:7103 (e.g. --host local)
--input Enable interactive prompts (default true).
--max-concurrency-container int Set the maximum number of container step instances that can execute concurrently across all pipeline instances (default 25).
--max-concurrency-function int Set the maximum number of function step instances that can execute concurrently across all pipeline instances (default 50).
--max-concurrency-http int Set the maximum number of http step instances that can execute concurrently across all pipeline instances (default 500).
--max-concurrency-query int Set the maximum number of query step instances that can execute concurrently across all pipeline instances (default 50).
--mod-location Sets the Flowpipe workspace working directory. If not specified, the workspace directory will be set to the current working directory. See FLOWPIPE_MOD_LOCATION for details.
--output Select a console output format: pretty, plain, yaml or json (default pretty).
-v, --version Display Flowpipe version.
--workspace Sets the Flowpipe workspace profile. If not specified, the default workspace will be used if it exists. See FLOWPIPE_WORKSPACE for details.

Exit Codes

ValueNameDescription
0ExitCodeSuccessfulFlowpipe ran successfully
1ExitCodeExecutionPausedFlowpipe ran without errors but paused waiting input
2ExitCodeExecutionFailedFlowpipe completed with one or more errors
3ExitCodeExecutionCancelledThe Flowpipe command was canceelled by user request
61ExitCodeModInitFailedMod init failed
62ExitCodeModInstallFailedMod install failed
250ExitCodeInitializationFailedInitialization failed
251ExitCodeBindPortUnavailableNetwork port binding failed
252ExitCodeNoModFileThe command requires a mod, but no mod file was found
253ExitCodeFileSystemAccessFailureFile system access failed
254ExitCodeInsufficientOrWrongInputsRuntime error - insufficient or incorrect input
255ExitCodeUnknownErrorPanicRuntime error - an unknown panic occurred