# Powerpipe CLI


# Powerpipe CLI

## Sub-Commands

| Command | Description
|-|-
| [powerpipe help](cli/help)      | Help about any command.
| [powerpipe detection](cli/detection)    | List, view, and run Powerpipe detections.
| [powerpipe login](cli/login)    | Log in to Turbot Pipes.
| [powerpipe mod](cli/mod)        | Powerpipe mod management.
| [powerpipe benchmark](cli/benchmark) | List, view, and run Powerpipe benchmarks.
| [powerpipe control](cli/control)| List and view Powerpipe controls.
| [powerpipe dashboard](cli/dashboard) | List and view Powerpipe dashboards.
| [powerpipe query](cli/query)    | List and view Powerpipe queries.
| [powerpipe server](cli/server)  | Run Powerpipe server, including triggers and integrations.
| [powerpipe variable](cli/variable)| List and view Powerpipe variables.


## Global Flags

<table>
<thead>
  <tr> 
    <th> Flag </th> 
    <th> Description </th> 
  </tr>
</thead>

<tbody>
  <tr> 
    <td nowrap="true"> `--config-path` </td> 
    <td>  
    Sets the search path for <a href = "/docs/reference/config-files">configuration files</a>. 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 <a href="/docs/reference/config-files/workspace"> workspaces </a> and credentials centrally in the `~/.powerpipe/config` directory, but override them in the mod location if desired.
    </td> 
  </tr>   

  <tr> 
    <td nowrap="true"> `-h`, `--help` </td> 
    <td>  Help for Powerpipe. </td> 
  </tr>

  <tr> 
    <td nowrap="true"> `--install-dir`  </td> 
    <td> 
    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 <a href="/docs/run#configuration-files">configuration search path </a> is also relative to this installation directory.  See <a href="/docs/reference/env-vars/powerpipe_install_dir">POWERPIPE_INSTALL_DIR</a> for details.
    </td>
  </tr>

  <tr> 
    <td nowrap="true"> `--mod-location`  </td> 
    <td> Sets the Powerpipe workspace working directory.  If not specified, the workspace directory will be set to the current working directory.  See <a href="/docs/reference/env-vars/powerpipe_mod_location">POWERPIPE_MOD_LOCATION</a> for details. </td>
  </tr>

   <tr> 
    <td nowrap="true">  `--output` </td> 
    <td>  Select a console output format: `pretty`, `plain`, `yaml` or `json` (default `pretty`). </td>
  </tr>

  <tr> 
    <td nowrap="true"> `-v`, `--version`  </td> 
    <td>  Display Powerpipe version. </td> 
  </tr>

  <tr> 
    <td nowrap="true"> `--workspace	`  </td> 
    <td>  Sets the Powerpipe workspace profile. If not specified, the default workspace will be used if it exists. See <a href="/docs/reference/env-vars/powerpipe_workspace">POWERPIPE_WORKSPACE</a> for details. </td> 
  </tr>
</tbody>

</table>


---

## 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