steampipe mod
Steampipe mod management.
Mods provide an easy way to share Steampipe queries, controls, and benchmarks. Find mods using the public registry at hub.steampipe.io.
Usage
Available Commands:
| Command | Description |
|---|---|
init | Initialize the current directory with a mod.sp file |
install | Install one or more mods and their dependencies |
list | List currently installed mods |
uninstall | Uninstall a mod and its dependencies |
update | Update one or more mods and their dependencies |
| Flag | Description |
|---|---|
--dry-run | Show which mods would be installed/updated/uninstalled without modifying them (default false). |
--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. |
--prune | Remove unused mods and dependencies when doing mod update and mod install (default true). |
Examples
List installed mods:
Install a mod and add the require statement to your mod.sp:
Install an exact version of a mod and update the require statement to your mod.sp. This may upgrade or downgrade the mod if it is already installed:
Install a version of a mod using a semver constraint and update the require statement to your mod.sp. This may upgrade or downgrade the mod if it is already installed:
Install all mods specified in the mod.sp and their dependencies:
Preview what steampipe mod install will do, without actually installing anything:
Update a mod to the latest version allowed by its current constraint:
Update all mods specified in the mod.sp and their dependencies to the latest versions that meet their constraints, and install any that are missing:
Uninstall a mod:
Preview uninstalling a mod, but don't uninstall it: