> ## Documentation Index
> Fetch the complete documentation index at: https://docs-xcor.paloaltonetworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Pipeline CLI

> Learn about the Palo Alto Networks Telemetry Pipeline command-line tool.

> [!NOTE]
>
> This information is for Palo Alto Networks Telemetry Pipeline, which is a standalone
> product separate from Palo Alto Networks Cortex XCOR.

Pipeline CLI is the Palo Alto Networks Telemetry Pipeline command-line app.

## Get started

To install Pipeline CLI, [Install Pipeline CLI](https://docs-xcor.paloaltonetworks.com/ingest/pipeline/pipeline-cli/install.md).

After you install Pipeline CLI, you'll need to [authenticate](https://docs-xcor.paloaltonetworks.com/ingest/pipeline/pipeline-cli/authenticate.md)
with Palo Alto Networks Telemetry Pipeline.

## View command list

To view a full list of available commands and flags, run:

```shell theme={null}
calyptia help
```

You can also prepend `calyptia help` to a specific command to view more information
about that command.

> [!NOTE]
>
> Pipeline CLI supports different commands for Palo Alto Networks Telemetry Pipeline v2 and
> Palo Alto Networks Telemetry Pipeline v3. Depending on whether the
> [active project](https://docs-xcor.paloaltonetworks.com/ingest/pipeline/pipeline-cli/authenticate.md#view-active-project)
> is a v2 project or a v3 project, running `calyptia help` displays commands relevant
> to that version.

## View current version

To view the version of Pipeline CLI that you currently have installed, run
the following command:

```shell theme={null}
calyptia version
```

## Command autocompletion

> This feature is compatible only with v2 projects.

You can add support for shell command autocompletion with Pipeline CLI for Bash,
Zsh, Fish, and PowerShell by using the `calyptia completion` command.

This section provides detailed steps for Bash and Zsh on macOS. For Linux-specific
details and instructions for Fish and PowerShell, see the output of
`calyptia completion --help`.

> [tab] Bash
>
> 1. Update or install `bash-completion`:
>
>    ```shell theme={null}
>    brew install bash-completion
>    ```
>
> 2. In a shell initialization script, such as `~/.bashrc`, add the following:
>
>    ```shell theme={null}
>    source "$(brew --prefix bash-completion)/etc/bash_completion"
>    eval "$(calyptia completion bash)"
>    ```
>
> 3. Restart the shell.

> [tab] Zsh
>
> 1. Go to your Zsh `site-functions` folder.
>
>    * If you installed Zsh with Homebrew, the path is
>      `/opt/homebrew/share/zsh/site-functions`.
>    * If you use the default macOS Zsh, the path is
>      `/usr/local/share/zsh/site-functions`.
>
> 2. Run the following command:
>
>    ```shell theme={null}
>    calyptia completion zsh > _calyptia
>    ```
>
> 3. Ensure your `~/.zshrc` file has
>    [`compinit`](https://zsh.sourceforge.io/Doc/Release/Completion-System.html) added.
>    If you use `oh-my-zsh`, it adds that for you.
>
> 4. Restart the shell.

You can now press `Tab` on the command line to automatically complete
Pipeline CLI commands.


## Related topics

- [Create and modify pipelines](https://docs-xcor.paloaltonetworks.com/ingest/pipeline/v2/build/create-modify.md)
- [Pipeline deployment strategies](https://docs-xcor.paloaltonetworks.com/ingest/pipeline/v2/configure/deployment-strategies.md)
- [Pipeline configuration files](https://docs-xcor.paloaltonetworks.com/ingest/pipeline/v2/configure/config-files.md)
- [Upgrade Palo Alto Networks Telemetry Pipeline](https://docs-xcor.paloaltonetworks.com/ingest/pipeline/v2/install/upgrade.md)
- [Uninstall Palo Alto Networks Telemetry Pipeline](https://docs-xcor.paloaltonetworks.com/ingest/pipeline/v2/install/uninstall.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.