powerpipe mod

Powerpipe mod management.

Mods provide an easy way to share Powerpipe pipelines. Find mods using the public registry at hub.powerpipe.io.

Usage

powerpipe mod init
powerpipe mod install [mod_path] [args]
powerpipe mod list [args]
powerpipe mod show mod_name [args]
powerpipe mod uninstall mod_name [args]
powerpipe mod update [mod_path] [args]

Sub-Commands

powerpipe mod init

Initialize the current directory with a mod.pp file.

Examples

Initialize a mod (create a mod.pp) in the current directory:

powerpipe mod init

Initialize a mod (create a mod.pp) in another directory:

powerpipe mod init --mod-location ~/my_mod

powerpipe mod install

Install one or more mods and their dependencies.

Arguments

Git URLs & Private Repos

Powerpipe uses git to install and update mods. When you run powerpipe mod install or powerpipe mod update, Powerpipe will first try using HTTPS and if that does not work it will try SSH. If your SSH keys are configured properly for git, you should be able to pull from private repos that you have access to, as well as public ones.

Examples

Install the latest version of a mod and add the require statement to your mod.pp:

powerpipe mod install github.com/turbot/steampipe-mod-aws-insights

Install an exact version of a mod and update the require statement to your mod.pp. This may upgrade or downgrade the mod if it is already installed:

powerpipe mod install github.com/turbot/steampipe-mod-aws-insights@0.1.0

Install a version of a mod using a semver constraint and update the require statement to your mod.pp. This may upgrade or downgrade the mod if it is already installed:

powerpipe mod install github.com/turbot/steampipe-mod-aws-insights@'^1'
powerpipe mod install github.com/turbot/steampipe-mod-aws-insights@1
powerpipe mod install github.com/turbot/steampipe-mod-aws-insights@1.x.x
powerpipe mod install github.com/turbot/steampipe-mod-aws-insights@'>=0.20'

Install all mods specified in the mod.pp and their dependencies:

powerpipe mod install

Preview what powerpipe mod install will do, without actually installing anything:

powerpipe mod install --dry-run

powerpipe mod list

List mods from the current mod and its direct dependents.

Examples

List mods:

powerpipe mod list

List all mods in JSON format:

powerpipe mod list --output json

List mods using settings from a workspace:

powerpipe mod list --workspace my_workspace

powerpipe mod show

Show details of a mod from the current mod or its direct dependents.

Examples

Show details of a single mod in the current mod:

powerpipe mod show aws_compliance

Show details of a mod in JSON format:

powerpipe mod show aws_compliance --output json

Show details of a mod using settings from a workspace:

powerpipe mod show aws_compliance -workspace my_workspace

powerpipe mod uninstall

Uninstall a mod and its dependencies.

Arguments

Examples

Uninstall a mod:

powerpipe mod uninstall github.com/turbot/steampipe-mod-azure-insights

Preview uninstalling a mod, but don't uninstall it:

powerpipe mod uninstall github.com/turbot/steampipe-mod-gcp-insights --dry-run

powerpipe mod update

Update one or more mods and their dependencies.

Arguments

Examples

Update a mod to the latest version allowed by its current constraint:

powerpipe mod update github.com/turbot/steampipe-mod-aws-insights

Update all mods specified in the mod.pp and their dependencies to the latest versions that meet their constraints, and install any that are missing:

powerpipe mod update