Steampipe CLI

Sub-Commands

CommandDescription
steampipe completionGenerate the autocompletion script for the specified shell
steampipe helpHelp about any command
steampipe loginLog in to Steampipe CLoud
steampipe pluginSteampipe plugin management
steampipe queryExecute SQL queries interactively or by argument
steampipe serviceSteampipe service management

Global Flags

Flag Description
-h, --help Help for Steampipe.
--install-dir Sets the directory for the Steampipe installation, in which the Steampipe database, plugins, and supporting files can be found. See STEAMPIPE_INSTALL_DIR for details.
--workspace Sets the Steampipe workspace profile. If not specified, the default workspace will be used if it exists. See STEAMPIPE_WORKSPACE for details.
-v, --version Display Steampipe version.

Exit Codes

ValueNameDescription
0ExitCodeSuccessfulSteampipe ran successfully, with no runtime errors, control errors, or alarms
11ExitCodePluginLoadingErrorPlugin loading error
12ExitCodePluginListFailurePlugin listing failed
13ExitCodePluginNotFoundPlugin not found
14ExitCodePluginInstallFailurePlugin install failed
31ExitCodeServiceSetupFailureService setup failed
32ExitCodeServiceStartupFailureService start failed
33ExitCodeServiceStopFailureService stop failed
41ExitCodeQueryExecutionFailedOne or more queries failed for steampipe query
51ExitCodeLoginCloudConnectionFailedConnecting to cloud failed
249ExitCodeInvalidExecutionEnvironmentSteampipe was run in an unsupported environment
250ExitCodeInitializationFailedInitialization failed
251ExitCodeBindPortUnavailableNetwork port binding failed
253ExitCodeFileSystemAccessFailureFile system access failed
254ExitCodeInsufficientOrWrongInputsRuntime error - insufficient or incorrect input
255ExitCodeUnknownErrorPanicRuntime error - an unknown panic occurred