Powerpipe CLI
Sub-Commands
| Command | Description |
|---|---|
| powerpipe help | Help about any command. |
| powerpipe login | Log in to Turbot Pipes. |
| powerpipe mod | Powerpipe mod management. |
| powerpipe benchmark | List, view, and run Powerpipe benchmarks. |
| powerpipe control | List and view Powerpipe controls. |
| powerpipe dashboard | List and view Powerpipe dashboards. |
| powerpipe query | List and view Powerpipe queries. |
| powerpipe server | Run Powerpipe server, including triggers and integrations. |
| powerpipe variable | List and view Powerpipe 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 (*.ppc) will be loaded from each path, with decreasing precedence. The default is .:$POWERPIPE_INSTALL_DIR/config (.:~/.powerpipe/config). This allows you to manage your workspaces and credentials centrally in the ~/.powerpipe/config directory, but override them in the mod location if desired. |
-h, --help | Help for Powerpipe. |
--install-dir | Set the installation directory for Powerpipe. Internal Powerpipe files will be written to and read from this path. The default is ~/.powerpipe. By default, the configuration search path is also relative to this installation directory. See POWERPIPE_INSTALL_DIR for details. |
--mod-location | Sets the Powerpipe workspace working directory. If not specified, the workspace directory will be set to the current working directory. See POWERPIPE_MOD_LOCATION for details. |
--output | Select a console output format: pretty, plain, yaml or json (default pretty). |
-v, --version | Display Powerpipe version. |
--workspace | Sets the Powerpipe workspace profile. If not specified, the default workspace will be used if it exists. See POWERPIPE_WORKSPACE for details. |
Exit Codes
| Value | Name | Description |
|---|---|---|
| 0 | ExitCodeSuccessful | Powerpipe ran successfully, with no runtime errors, control errors, or alarms |
| 1 | ExitCodeControlsAlarm | powerpipe benchmark run or powerpipe control run completed with no runtime or control errors, but there were one or more alarms |
| 2 | ExitCodeControlsError | powerpipe benchmark run or powerpipe control run completed with no runtime errors, but one or more control errors occurred |
| 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 powerpipe query run |
| 51 | ExitCodeLoginCloudConnectionFailed | Connecting to Pipes failed |
| 61 | ExitCodeModInitFailed | Mod init failed |
| 62 | ExitCodeModInstallFailed | Mod install failed |
| 249 | ExitCodeInvalidExecutionEnvironment | Powerpipe 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 |