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.13.tar.gz (361.1 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.13-py3-none-any.whl (103.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pipecat_ai_cli-0.1.13.tar.gz
  • Upload date:
  • Size: 361.1 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.13.tar.gz
Algorithm Hash digest
SHA256 02a8b87df3493eb12e489061558f1bc0069c40cb68ec9eb541730d41a5b2bd99
MD5 5defea875a5dc2d278574db7b2410112
BLAKE2b-256 7aaa19c03d091e50d7ff199d6d01a9f5167245ba50901d7b29380a96aae12aab

See more details on using hashes here.

Provenance

The following attestation bundles were made for pipecat_ai_cli-0.1.13.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.13-py3-none-any.whl.

File metadata

  • Download URL: pipecat_ai_cli-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 103.3 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.13-py3-none-any.whl
Algorithm Hash digest
SHA256 8bb72e248d7ff2082d544212a4bce749e4cc9d8f1af138138b35c9303fbaa5f5
MD5 15b7582bc7d9e9af1ade8ef068a6d1a6
BLAKE2b-256 690e6a05865efa34525b2b10ae8f0c527207ece0800dffe3016d5a27592e9816

See more details on using hashes here.

Provenance

The following attestation bundles were made for pipecat_ai_cli-0.1.13-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