-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
105 changed files
with
457 additions
and
3,974 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -50,51 +50,51 @@ tailpipe plugin [command] | |
|
||
Install or update a plugin: | ||
```bash | ||
steampipe plugin install aws | ||
tailpipe plugin install aws | ||
``` | ||
|
||
Install a specific version of a plugin: | ||
```bash | ||
steampipe plugin install [email protected] | ||
tailpipe plugin install [email protected] | ||
``` | ||
|
||
Install the latest version of a plugin matching a semver constraint: | ||
```bash | ||
steampipe plugin install aws@^0.107 | ||
tailpipe plugin install aws@^0.107 | ||
``` | ||
|
||
Note: if your semver constraint contain special characters you may need to quote it: | ||
```bash | ||
steampipe plugin install "aws@>=0.100" | ||
tailpipe plugin install "aws@>=0.100" | ||
``` | ||
|
||
Install all missing plugins that specified in configuration files. Do not download their default configuration files: | ||
|
||
```bash | ||
steampipe plugin install --skip-config | ||
tailpipe plugin install --skip-config | ||
``` | ||
|
||
List installed plugins: | ||
```bash | ||
steampipe plugin list | ||
tailpipe plugin list | ||
``` | ||
|
||
Uninstall a plugin: | ||
```bash | ||
steampipe plugin uninstall dmi/paper | ||
tailpipe plugin uninstall dmi/paper | ||
``` | ||
|
||
Update all plugins to the latest in the installed stream: | ||
```bash | ||
steampipe plugin update --all | ||
tailpipe plugin update --all | ||
``` | ||
|
||
Update the aws plugin to the latest version meeting the constraint: | ||
```bash | ||
steampipe plugin update aws@^0.107 | ||
tailpipe plugin update aws@^0.107 | ||
``` | ||
|
||
Update all plugins to the latest and hide the progress bar: | ||
```bash | ||
steampipe plugin update --all --progress=false | ||
tailpipe plugin update --all --progress=false | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,17 @@ | ||
--- | ||
title: flowpipe mod | ||
sidebar_label: flowpipe mod | ||
title: tailpipe mod | ||
sidebar_label: tailpipe mod | ||
--- | ||
|
||
# flowpipe mod | ||
Flowpipe mod management. | ||
# tailpipe mod | ||
Tailpipe mod management. | ||
|
||
Mods provide an easy way to share Flowpipe pipelines. Find mods using the public registry at [hub.flowpipe.io](https://hub.flowpipe.io/). | ||
Mods provide an easy way to share Tailpipe pipelines. Find mods using the public registry at [hub.tailpipe.io](https://hub.tailpipe.io/). | ||
|
||
|
||
## Usage | ||
```bash | ||
flowpipe mod [command] | ||
tailpipe mod [command] | ||
``` | ||
|
||
## Sub-Commands | ||
|
@@ -47,74 +47,74 @@ It is also possible to have more granular control of the update behavior - e.g. | |
|
||
## Git URLs & Private Repos | ||
|
||
Flowpipe uses `git` to install and update mods. When you run `flowpipe mod install` or `flowpipe mod update`, Flowpipe 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. | ||
Tailpipe uses `git` to install and update mods. When you run `tailpipe mod install` or `tailpipe mod update`, Tailpipe 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. | ||
|
||
When publishing mods, you should usually only depend on public mods (hosted in public repos) so that users of your mod don't encounter permissions issues. | ||
|
||
|
||
## Examples | ||
List installed mods: | ||
```bash | ||
flowpipe mod list | ||
tailpipe mod list | ||
``` | ||
|
||
Install a mod and add the `require` statement to your `mod.fp`: | ||
```bash | ||
flowpipe mod install github.com/turbot/flowpipe-mod-aws | ||
tailpipe mod install github.com/turbot/tailpipe-mod-aws | ||
``` | ||
|
||
Install an exact version of a mod and update the `require` statement to your `mod.fp`. This may upgrade or downgrade the mod if it is already installed: | ||
```bash | ||
flowpipe mod install github.com/turbot/flowpipe[email protected] | ||
tailpipe mod install github.com/turbot/tailpipe[email protected] | ||
``` | ||
|
||
Install a version of a mod using a semver constraint and update the `require` statement to your `mod.fp`. This may upgrade or downgrade the mod if it is already installed: | ||
```bash | ||
flowpipe mod install github.com/turbot/flowpipe-mod-aws@'^1' | ||
tailpipe mod install github.com/turbot/tailpipe-mod-aws@'^1' | ||
``` | ||
|
||
Install a mod from a GitHub tag: | ||
```bash | ||
flowpipe mod install github.com/turbot/flowpipe-mod-aws@my-tag | ||
tailpipe mod install github.com/turbot/tailpipe-mod-aws@my-tag | ||
``` | ||
|
||
Install a mod from a GitHub branch: | ||
```bash | ||
flowpipe mod install github.com/turbot/flowpipe-mod-aws#main | ||
tailpipe mod install github.com/turbot/tailpipe-mod-aws#main | ||
``` | ||
|
||
Install a mod from a local directory: | ||
```bash | ||
flowpipe mod install ../flowpipe-mod-aws | ||
tailpipe mod install ../tailpipe-mod-aws | ||
``` | ||
|
||
Install all mods specified in the `mod.fp` and their dependencies: | ||
```bash | ||
flowpipe mod install | ||
tailpipe mod install | ||
``` | ||
|
||
Preview what `flowpipe mod install` will do, without actually installing anything: | ||
Preview what `tailpipe mod install` will do, without actually installing anything: | ||
```bash | ||
flowpipe mod install --dry-run | ||
tailpipe mod install --dry-run | ||
``` | ||
|
||
Update a mod to the latest version allowed by its current constraint: | ||
```bash | ||
flowpipe mod update github.com/turbot/flowpipe-mod-aws | ||
tailpipe mod update github.com/turbot/tailpipe-mod-aws | ||
``` | ||
|
||
Update all mods specified in the `mod.fp` and their dependencies to the latest versions that meet their constraints, and install any that are missing: | ||
```bash | ||
flowpipe mod update | ||
tailpipe mod update | ||
``` | ||
|
||
|
||
Uninstall a mod: | ||
```bash | ||
flowpipe mod uninstall github.com/turbot/flowpipe-mod-azure | ||
tailpipe mod uninstall github.com/turbot/tailpipe-mod-azure | ||
``` | ||
|
||
Preview uninstalling a mod, but don't uninstall it: | ||
```bash | ||
flowpipe mod uninstall github.com/turbot/flowpipe-mod-gcp --dry-run | ||
tailpipe mod uninstall github.com/turbot/tailpipe-mod-gcp --dry-run | ||
``` |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.