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

# CLI Overview

> The Pipecat CLI scaffolds new projects, runs behavioral evals, and deploys agents to Pipecat Cloud from your terminal.

> [card] [Start a Project](https://docs.pipecat.ai/api-reference/cli/init.md)
>
> Initialize a project, then build with a coding agent or scaffold a bot

> [card] [Run Behavioral Evals](https://docs.pipecat.ai/api-reference/cli/eval.md)
>
> Test your agents with scripted scenarios and an LLM judge

> [card] [Give Your Agent Context](https://docs.pipecat.ai/api-reference/cli/context-hub.md)
>
> Index current Pipecat docs and API source for your coding agent

> [card] [Deploy to Cloud](https://docs.pipecat.ai/api-reference/cli/cloud/auth.md)
>
> Push your bots to production with one command

## Requirements

* Python 3.11 or later

## Installation

The CLI ships with `pipecat-ai` as the optional `cli` extra. Install it globally with [uv](https://docs.astral.sh/uv/):

```bash theme={null}
uv tool install "pipecat-ai[cli]"
```

Verify installation:

```bash theme={null}
pipecat --version
```

> [!TIP]
>
> All commands can use either `pipecat` or the shorter `pc` alias.

This gives you `pipecat init`, `pipecat eval`, and `pipecat context-hub`. The Context Hub bundles a local retrieval stack, so it accounts for most of the extra's install size. Deploy commands come from a separate package, co-installed with `--with`:

```bash theme={null}
uv tool install "pipecat-ai[cli]" --with pipecatcloud
```

> [!WARNING]
>
> `--with` replaces the tool environment rather than adding to it, so every run
> must name every plugin you want.

`pipecat cloud --version` prints the installed `pipecatcloud` version.

`pipecat cloud` still appears in `pipecat --help` without that package, and prints how to enable itself when run.

## Upgrading

Running `uv tool install` again on an installed CLI leaves it at its current version. Upgrade it with:

```bash theme={null}
uv tool upgrade pipecat-ai
```

The upgrade keeps the `cli` extra and any `--with` packages, such as `pipecatcloud`, from the original install. Run `pipecat --version` to confirm the new version.

## Commands

* **[`pipecat init`](https://docs.pipecat.ai/api-reference/cli/init)** - Initialize and scaffold a new Pipecat project, the single entry point for new projects (built in)
* **[`pipecat eval`](https://docs.pipecat.ai/api-reference/cli/eval)** - Run behavioral evals against your agents
* **[`pipecat context-hub`](https://docs.pipecat.ai/api-reference/cli/context-hub)** - Query the Pipecat Context Hub and register it with your coding agent (built in)
* **[`pipecat cloud`](https://docs.pipecat.ai/api-reference/cli/cloud/auth)** - Deploy and manage bots on Pipecat Cloud (requires `pipecatcloud`)

## Output modes and exit codes

Every `pipecat cloud` command accepts a global `--output rich|plain|json` option and exits non-zero on failure, which matters most in CI. See [Output Modes and Exit Codes](https://docs.pipecat.ai/api-reference/cli/cloud/output.md) for the full contract.

## Getting Help

View help for any command:

```bash theme={null}
pipecat --help
pipecat init --help
pipecat eval --help
pipecat context-hub --help
pipecat cloud --help
```

## Next Steps

> [card] [Build Your First Bot](https://docs.pipecat.ai/pipecat/get-started/build-your-next-bot.md)
>
> Initialize your project and start building with pipecat init


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