Steampipe CLI
Sub-Commands
| Command | Description |
|---|---|
| steampipe check | Run Steampipe benchmarks and controls |
| steampipe completion | Generate the autocompletion script for the specified shell |
| steampipe dashboard | Steampipe dashboards |
| steampipe help | Help about any command |
| steampipe login | Log in to Steampipe CLoud |
| steampipe mod | Steampipe mod management |
| steampipe plugin | Steampipe plugin management |
| steampipe query | Execute SQL queries interactively or by argument |
| steampipe service | Steampipe service management |
| steampipe variable | Steampipe variable management |
Global Flags
| Flag | Description |
|---|---|
--cloud-host | Sets the Steampipe Cloud host used when connecting to Steampipe Cloud workspaces. See STEAMPIPE_CLOUD_HOST for details. |
--cloud-token | Sets the Steampipe Cloud authentication token used when connecting to Steampipe Cloud workspaces. See STEAMPIPE_CLOUD_TOKEN for details. |
-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. |
--mod-location | Sets the Steampipe workspace working directory. If not specified, the workspace directory will be set to the current working directory. See STEAMPIPE_MOD_LOCATION for details. |
-v, --version | Display Steampipe version. |
--workspace | Sets the Steampipe workspace profile. If not specified, the default workspace will be used if it exists. See STEAMPIPE_WORKSPACE for details. |
--workspace-chdir | (DEPRECATED: please use --mod-location) Sets the Steampipe workspace directory. If not specified, the workspace directory will be set to the current working directory. See STEAMPIPE_WORKSPACE_CHDIR for details. |
--workspace-database | Sets the database that Steampipe will connect to. This can be local (the default) or a remote Steampipe Cloud database. See STEAMPIPE_WORKSPACE_DATABASE for details. |
Exit Codes
| Value | Name | Description |
|---|---|---|
| 0 | ExitCodeSuccessful | Steampipe ran successfully, with no runtime errors, control errors, or alarms |
| 1 | ExitCodeControlsAlarm | steampipe check completed with no runtime or control errors, but there were one or more alarms |
| 2 | ExitCodeControlsError | steampipe check completed with no runtime errors, but one or more control errors occurred |
| 11 | ExitCodePluginLoadingError | Plugin loading error |
| 12 | ExitCodePluginListFailure | Plugin listing failed |
| 13 | ExitCodePluginNotFound | Plugin not found |
| 14 | ExitCodePluginInstallFailure | Plugin install failed |
| 21 | ExitCodeSnapshotCreationFailed | Snapshot creation failed |
| 22 | ExitCodeSnapshotUploadFailed | Snapshot upload failed |
| 31 | ExitCodeServiceSetupFailure | Service setup failed |
| 32 | ExitCodeServiceStartupFailure | Service start failed |
| 33 | ExitCodeServiceStopFailure | Service stop failed |
| 41 | ExitCodeQueryExecutionFailed | One or more queries failed for steampipe query |
| 51 | ExitCodeLoginCloudConnectionFailed | Connecting to cloud failed |
| 61 | ExitCodeModInitFailed | Mod init failed |
| 62 | ExitCodeModInstallFailed | Mod install failed |
| 249 | ExitCodeInvalidExecutionEnvironment | Steampipe was run in an unsupported environment |
| 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 |