Skip to content

Commit

Permalink
continue buildout
Browse files Browse the repository at this point in the history
  • Loading branch information
judell committed Nov 22, 2024
1 parent 799f043 commit 199ae2d
Show file tree
Hide file tree
Showing 105 changed files with 457 additions and 3,974 deletions.
6 changes: 0 additions & 6 deletions docs/collect/index.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/query/index.md

This file was deleted.

8 changes: 4 additions & 4 deletions docs/reference/cli/collect.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Run a [collection](/docs/reference/config-files/integration).

## Usage
```bash
flowpipe integration [command] [flags]
tailpipe integration [command] [flags]
```

## Sub-Commands
Expand All @@ -26,17 +26,17 @@ flowpipe integration [command] [flags]
List integrations:

```bash
flowpipe integration list
tailpipe integration list
```

View integration details:

```bash
flowpipe integration show slack.default
tailpipe integration show slack.default
```

List integrations in JSON format:

```bash
flowpipe integration list --output json
tailpipe integration list --output json
```
6 changes: 3 additions & 3 deletions docs/reference/cli/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ tailpipe help [command] [flags]
## Examples
Show help:
```bash
flowpipe help
tailpipe help
```
Show help for the `mod` sub-command:
```bash
flowpipe help mod
tailpipe help mod
```
Show help for the `mod install` sub-command:
```bash
flowpipe help mod install
tailpipe help mod install
```
22 changes: 11 additions & 11 deletions docs/reference/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,26 +27,26 @@ sidebar_label: Tailpipe CLI
<tr>
<td nowrap="true"> <inlineCode>--config-path</inlineCode> </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 (<inlineCode>*.fpc</inlineCode>) will be loaded from each path, with decreasing precedence. The default is <inlineCode>.:$FLOWPIPE_INSTALL_DIR/config</inlineCode> (<inlineCode>.:~/.flowpipe/config</inlineCode>). This allows you to manage your <a href="/docs/reference/config-files/workspace"> workspaces </a> and <a href="/docs/reference/config-files/connection">connections</a> centrally in the <inlineCode>~/.flowpipe/config</inlineCode> directory, but override them in the working directory / mod location if desired.
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 (<inlineCode>*.fpc</inlineCode>) will be loaded from each path, with decreasing precedence. The default is <inlineCode>.:$TAILPIPE_INSTALL_DIR/config</inlineCode> (<inlineCode>.:~/.tailpipe/config</inlineCode>). This allows you to manage your <a href="/docs/reference/config-files/workspace"> workspaces </a> and <a href="/docs/reference/config-files/connection">connections</a> centrally in the <inlineCode>~/.tailpipe/config</inlineCode> directory, but override them in the working directory / mod location if desired.
</td>
</tr>

<tr>
<td nowrap="true"> <inlineCode>--data-dir</inlineCode> </td>
<td>
Sets the event store data directory. Flowpipe defaults to the `.flowpipe` directory in the current mod directory. This argument allows you to specify a different directory.
Sets the event store data directory. Tailpipe defaults to the `.tailpipe` directory in the current mod directory. This argument allows you to specify a different directory.
</td>
</tr>


<tr>
<td nowrap="true"> <inlineCode>-h</inlineCode>, <inlineCode>--help</inlineCode> </td>
<td> Help for Flowpipe. </td>
<td> Help for Tailpipe. </td>
</tr>
<tr>
<td nowrap="true"> <inlineCode>--host</inlineCode> </td>
<td> Run the command against a local or remote server instance. You may specify the full host and port (e.g. <inlineCode>--host https://flowpipe.my-org.com:7103</inlineCode>), or use the keyword <inlineCode>local</inlineCode> to connect to the local server instance as a shortcut for <inlineCode>https://localhost:7103</inlineCode> (e.g. <inlineCode>--host local</inlineCode>) </td>
<td> Run the command against a local or remote server instance. You may specify the full host and port (e.g. <inlineCode>--host https://tailpipe.my-org.com:7103</inlineCode>), or use the keyword <inlineCode>local</inlineCode> to connect to the local server instance as a shortcut for <inlineCode>https://localhost:7103</inlineCode> (e.g. <inlineCode>--host local</inlineCode>) </td>
</tr>

<tr>
Expand Down Expand Up @@ -76,7 +76,7 @@ sidebar_label: Tailpipe CLI

<tr>
<td nowrap="true"> <inlineCode>--mod-location</inlineCode> </td>
<td> Sets the Flowpipe workspace working directory. If not specified, the workspace directory will be set to the current working directory. See <a href="/docs/reference/env-vars/flowpipe_mod_location">FLOWPIPE_MOD_LOCATION</a> for details. </td>
<td> Sets the Tailpipe workspace working directory. If not specified, the workspace directory will be set to the current working directory. See <a href="/docs/reference/env-vars/tailpipe_mod_location">TAILPIPE_MOD_LOCATION</a> for details. </td>
</tr>

<tr>
Expand All @@ -86,12 +86,12 @@ sidebar_label: Tailpipe CLI

<tr>
<td nowrap="true"> <inlineCode>-v</inlineCode>, <inlineCode>--version</inlineCode> </td>
<td> Display Flowpipe version. </td>
<td> Display Tailpipe version. </td>
</tr>

<tr>
<td nowrap="true"> <inlineCode>--workspace </inlineCode> </td>
<td> Sets the Flowpipe workspace profile. If not specified, the default workspace will be used if it exists. See <a href="/docs/reference/env-vars/flowpipe_workspace">FLOWPIPE_WORKSPACE</a> for details. </td>
<td> Sets the Tailpipe workspace profile. If not specified, the default workspace will be used if it exists. See <a href="/docs/reference/env-vars/tailpipe_workspace">TAILPIPE_WORKSPACE</a> for details. </td>
</tr>

</table>
Expand Down Expand Up @@ -121,10 +121,10 @@ sidebar_label: Tailpipe CLI

| Value | Name | Description
|---------|---------------------------------------|----------------------------------------
| **0** | `ExitCodeSuccessful` | Flowpipe ran successfully
| **1** | `ExitCodeExecutionPaused` | Flowpipe ran without errors but paused waiting input
| **2** | `ExitCodeExecutionFailed` | Flowpipe completed with one or more errors
| **3** | `ExitCodeExecutionCancelled` | The Flowpipe command was canceelled by user request
| **0** | `ExitCodeSuccessful` | Tailpipe ran successfully
| **1** | `ExitCodeExecutionPaused` | Tailpipe ran without errors but paused waiting input
| **2** | `ExitCodeExecutionFailed` | Tailpipe completed with one or more errors
| **3** | `ExitCodeExecutionCancelled` | The Tailpipe command was canceelled by user request
| **61** | `ExitCodeModInitFailed` | Mod init failed
| **62** | `ExitCodeModInstallFailed` | Mod install failed
| **250** | `ExitCodeInitializationFailed` | Initialization failed
Expand Down
20 changes: 10 additions & 10 deletions docs/reference/cli/plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
42 changes: 21 additions & 21 deletions docs/reference/cli/query.md
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
Expand Down Expand Up @@ -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
```
32 changes: 0 additions & 32 deletions docs/reference/config-files/connection/abuseipdb.md

This file was deleted.

55 changes: 0 additions & 55 deletions docs/reference/config-files/connection/alicloud.md

This file was deleted.

Loading

0 comments on commit 199ae2d

Please sign in to comment.