Skip to main content

CLI for building, deploying, and monitoring Pipecat voice agents

Project description

Pipecat CLI

A complete toolkit for building, deploying, and monitoring Pipecat AI voice agents.

  • Scaffold new projects with pipecat init
  • Deploy to production with pipecat cloud
  • Monitor live bots with pipecat tail

Requirements

  • Python 3.10+

Installation

uv tool install pipecat-ai-cli

This installs the CLI globally. If you don't have uv, you can also use pipx install pipecat-ai-cli.

Tip: All commands can use either pipecat or the shorter pc alias.

Optional: Install Tail Dashboard

To use the pipecat tail monitoring dashboard, install with the tail extra:

uv tool install "pipecat-ai-cli[tail]"

Create a New Project

Create a new Pipecat project interactively:

pipecat init

The CLI will guide you through selecting:

  • Bot type and client framework
  • Transport provider (Daily, Twilio, etc.)
  • Pipeline mode (Cascade or Realtime)
  • AI services (STT, LLM, TTS)
  • Optional features and deployment target

Generated Project Structure

mybot/
├── server/                  # Python bot server
│   ├── bot.py              # Main bot implementation
│   ├── pyproject.toml      # Python dependencies
│   ├── .env.example        # Environment variables template
│   ├── Dockerfile          # Container image (if cloud enabled)
│   └── pcc-deploy.toml     # Deployment config (if cloud enabled)
├── client/                  # Web client (if generated)
│   ├── src/
│   ├── package.json
│   └── ...
├── .gitignore
└── README.md                # Project setup instructions

Deploy to Pipecat Cloud

Deploy and manage your bot in production with Pipecat Cloud:

# Authenticate
pipecat cloud auth login

# Build and deploy
pipecat cloud docker build-push
pipecat cloud deploy

# Manage deployments
pipecat cloud agent list
pipecat cloud agent logs <agent-name>

Cloud commands provide:

  • 🔐 Authentication and credential management
  • 🐳 Docker build and registry integration
  • 🚀 One-command deployment
  • 📊 Agent status and log monitoring
  • 🔧 Runtime configuration management

Note: When you enable "Deploy to Pipecat Cloud" during project creation, the necessary Docker and deployment config files are automatically generated.

Learn more in the Pipecat Cloud documentation.

Monitor Your Bot

Use the built-in Tail dashboard to monitor your bot in real-time:

# Connect to local bot (default: ws://localhost:9292)
pipecat tail

# Connect to remote session
pipecat tail --url wss://your-bot.example.com

Note: The tail command requires the optional tail extra. Install with uv tool install "pipecat-ai-cli[tail]" if not already installed.

Tail provides:

  • 📜 Real-time system logs
  • 💬 Live conversation tracking
  • 🔊 Audio level monitoring
  • 📈 Service metrics and usage stats

📚 Next steps

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pipecat_ai_cli-0.1.8.tar.gz (359.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pipecat_ai_cli-0.1.8-py3-none-any.whl (107.1 kB view details)

Uploaded Python 3

File details

Details for the file pipecat_ai_cli-0.1.8.tar.gz.

File metadata

  • Download URL: pipecat_ai_cli-0.1.8.tar.gz
  • Upload date:
  • Size: 359.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pipecat_ai_cli-0.1.8.tar.gz
Algorithm Hash digest
SHA256 eda04448dedc54d40b706bc1973864d7589f120ae3faf4b98112adfbf250d729
MD5 197b5b049b77b6387460855adc118b0e
BLAKE2b-256 c97886f5338a0c65b918523d86079739e35314444bd3e8475b0380e256e67906

See more details on using hashes here.

Provenance

The following attestation bundles were made for pipecat_ai_cli-0.1.8.tar.gz:

Publisher: publish.yaml on pipecat-ai/pipecat-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pipecat_ai_cli-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: pipecat_ai_cli-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 107.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pipecat_ai_cli-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 252618b7cf8dae52dcc36f99fa26a8558005dc9ddb8c17fd63ba4d5c93ea7dc7
MD5 8966bb756d64cc0509a62dd2ae1d51b8
BLAKE2b-256 9089e5f177d355609697937e6ff848559b8126386c80f5e6bee5482abcd884c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pipecat_ai_cli-0.1.8-py3-none-any.whl:

Publisher: publish.yaml on pipecat-ai/pipecat-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page