Tailpipe CLI

Sub-Commands

Command	Description
tailpipe collect	Run a collection
tailpipe compact	Compact multiple parquet files per day to one per day
tailpipe connect	Return a connection string for a database
tailpipe help	Help about any command
tailpipe partition	List, show, and delete Tailpipe partitions
tailpipe plugin	Tailpipe plugin management
tailpipe query	Execute a query against the workspace database
tailpipe source	List and show Tailpipe sources
tailpipe table	List and show Tailpipe tables

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 (*.tpc) will be loaded from each path, with decreasing precedence. The default is .:$TAILPIPE_INSTALL_DIR/config (.:~/.tailpipe/config). This allows you to manage your workspaces and connections centrally in the ~/.tailpipe/config directory, but override them in the working directory / mod location if desired.
--workspace	Sets the Tailpipe workspace profile. If not specified, the default workspace will be used if it exists. See workspace for details.

Flag

Description

--config-path

Sets the search path for configuration files. This argument accepts a colon-separated list of directories. All configuration files (*.tpc) will be loaded from each path, with decreasing precedence. The default is .:$TAILPIPE_INSTALL_DIR/config (.:~/.tailpipe/config). This allows you to manage your workspaces and connections centrally in the ~/.tailpipe/config directory, but override them in the working directory / mod location if desired.

--workspace

Sets the Tailpipe workspace profile. If not specified, the default workspace will be used if it exists. See workspace for details.

Exit Codes

Value	Name	Description
0	ExitCodeSuccessful	Tailpipe ran successfully
1	ExitCodeExecutionPaused	Tailpipe ran without errors but paused waiting input
2	ExitCodeExecutionFailed	Tailpipe completed with one or more errors
3	ExitCodeExecutionCancelled	The Tailpipe command was canceelled by user request
61	ExitCodeModInitFailed	Mod init failed
62	ExitCodeModInstallFailed	Mod install failed
250	ExitCodeInitializationFailed	Initialization failed
251	ExitCodeBindPortUnavailable	Network port binding failed
252	ExitCodeNoModFile	The command requires a mod, but no mod file was found
253	ExitCodeFileSystemAccessFailure	File system access failed
254	ExitCodeInsufficientOrWrongInputs	Runtime error - insufficient or incorrect input
255	ExitCodeUnknownErrorPanic	Runtime error - an unknown panic occurred