Skip to content

Commit

Permalink
Merge pull request #31 from turbot/updates-3
Browse files Browse the repository at this point in the history
ref/cli/index
  • Loading branch information
judell authored Jan 28, 2025
2 parents 333e24d + b01b62c commit 566cc66
Showing 1 changed file with 2 additions and 61 deletions.
63 changes: 2 additions & 61 deletions docs/reference/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ title: Tailpipe CLI

## Global Flags

>[!NOTE]
>Copied from steampipe, needs review

<table>
<tr>
Expand All @@ -35,71 +33,14 @@ title: Tailpipe CLI
<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 (`*.tpc`) will be loaded from each path, with decreasing precedence. The default is `.:$TAILPIPE_INSTALL_DIR/config` (`.:~/.tailpipe/config`). 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 `~/.tailpipe/config` 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 (`*.tpc`) will be loaded from each path, with decreasing precedence. The default is `.:$TAILPIPE_INSTALL_DIR/config` (`.:~/.tailpipe/config`). 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 `~/.tailpipe/config` directory, but override them in the working directory / mod location if desired.
</td>
</tr>

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

<tr>
<td nowrap="true"> `--input` </td>
<td> Enable interactive prompts (default `true`). </td>
</tr>


<tr>
<td nowrap="true"> `--max-concurrency-container int` </td>
<td>Set the maximum number of `container` step instances that can execute concurrently across all pipeline instances (default `25`). </td>
</tr>
<tr>
<td nowrap="true"> `--max-concurrency-function int` </td>
<td> Set the maximum number of `function` step instances that can execute concurrently across all pipeline instances (default `50`). </td>
</tr>
<tr>
<td nowrap="true"> `--max-concurrency-http int` </td>
<td> Set the maximum number of `http` step instances that can execute concurrently across all pipeline instances (default `500`). </td>
</tr>
<tr>
<td nowrap="true"> `--max-concurrency-query int` </td>
<td> Set the maximum number of `query` step instances that can execute concurrently across all pipeline instances (default `50`). </td>
</tr>



<tr>
<td nowrap="true"> `--mod-location` </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>
<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 Tailpipe version. </td>
</tr>

<tr>
<td nowrap="true"> `--workspace ` </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>
<td> Sets the Tailpipe workspace profile. If not specified, the default workspace will be used if it exists. See <a href="/docs/reference/config-files/workspace">workspace</a> for details. </td>
</tr>

</table>
Expand Down

0 comments on commit 566cc66

Please sign in to comment.