# Pipecat CLI
A complete toolkit for building, deploying, and monitoring [Pipecat](https://github.com/pipecat-ai/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
```bash
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.
## Create a New Project
Create a new Pipecat project interactively:
```bash
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
```
## Monitor Your Bot
Use the built-in Tail dashboard to monitor your bot in real-time:
```bash
# Connect to local bot (default: ws://localhost:9292)
pipecat tail
# Connect to remote session
pipecat tail --url wss://your-bot.example.com
```
Tail provides:
- 📜 Real-time system logs
- 💬 Live conversation tracking
- 🔊 Audio level monitoring
- 📈 Service metrics and usage stats
## Deploy to Pipecat Cloud
Deploy and manage your bot in production with [Pipecat Cloud](https://www.daily.co/products/pipecat-cloud/):
```bash
# 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](https://docs.pipecat.ai/deployment/pipecat-cloud/introduction).
## 📚 Next steps
- See the [Pipecat documentation](https://docs.pipecat.ai) for more about building bots
- Learn how to extend the template using [examples & recipes](https://docs.pipecat.ai/examples)
- [Join our Discord](https://discord.gg/pipecat) to get help or provide feedback
Raw data
{
"_id": null,
"home_page": null,
"name": "pipecat-ai-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "pipecat, ai, cli, voice, agents, scaffolding",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/46/44/cf1e357fd6d61932cff89e2b6375b481524a376450cd6894ab1702ffdaf7/pipecat_ai_cli-0.1.0.tar.gz",
"platform": null,
"description": "# Pipecat CLI\n\nA complete toolkit for building, deploying, and monitoring [Pipecat](https://github.com/pipecat-ai/pipecat) AI voice agents.\n\n- **Scaffold** new projects with `pipecat init`\n- **Deploy** to production with `pipecat cloud`\n- **Monitor** live bots with `pipecat tail`\n\n## Requirements\n\n- Python 3.10+\n\n## Installation\n\n```bash\nuv tool install pipecat-ai-cli\n```\n\nThis installs the CLI globally. If you don't have `uv`, you can also use `pipx install pipecat-ai-cli`.\n\n> **Tip:** All commands can use either `pipecat` or the shorter `pc` alias.\n\n## Create a New Project\n\nCreate a new Pipecat project interactively:\n\n```bash\npipecat init\n```\n\nThe CLI will guide you through selecting:\n\n- Bot type and client framework\n- Transport provider (Daily, Twilio, etc.)\n- Pipeline mode (Cascade or Realtime)\n- AI services (STT, LLM, TTS)\n- Optional features and deployment target\n\n**Generated Project Structure**\n\n```\nmybot/\n\u251c\u2500\u2500 server/ # Python bot server\n\u2502 \u251c\u2500\u2500 bot.py # Main bot implementation\n\u2502 \u251c\u2500\u2500 pyproject.toml # Python dependencies\n\u2502 \u251c\u2500\u2500 .env.example # Environment variables template\n\u2502 \u251c\u2500\u2500 Dockerfile # Container image (if cloud enabled)\n\u2502 \u2514\u2500\u2500 pcc-deploy.toml # Deployment config (if cloud enabled)\n\u251c\u2500\u2500 client/ # Web client (if generated)\n\u2502 \u251c\u2500\u2500 src/\n\u2502 \u251c\u2500\u2500 package.json\n\u2502 \u2514\u2500\u2500 ...\n\u251c\u2500\u2500 .gitignore\n\u2514\u2500\u2500 README.md # Project setup instructions\n```\n\n## Monitor Your Bot\n\nUse the built-in Tail dashboard to monitor your bot in real-time:\n\n```bash\n# Connect to local bot (default: ws://localhost:9292)\npipecat tail\n\n# Connect to remote session\npipecat tail --url wss://your-bot.example.com\n```\n\nTail provides:\n\n- \ud83d\udcdc Real-time system logs\n- \ud83d\udcac Live conversation tracking\n- \ud83d\udd0a Audio level monitoring\n- \ud83d\udcc8 Service metrics and usage stats\n\n## Deploy to Pipecat Cloud\n\nDeploy and manage your bot in production with [Pipecat Cloud](https://www.daily.co/products/pipecat-cloud/):\n\n```bash\n# Authenticate\npipecat cloud auth login\n\n# Build and deploy\npipecat cloud docker build-push\npipecat cloud deploy\n\n# Manage deployments\npipecat cloud agent list\npipecat cloud agent logs <agent-name>\n```\n\nCloud commands provide:\n\n- \ud83d\udd10 Authentication and credential management\n- \ud83d\udc33 Docker build and registry integration\n- \ud83d\ude80 One-command deployment\n- \ud83d\udcca Agent status and log monitoring\n- \ud83d\udd27 Runtime configuration management\n\n**Note:** When you enable \"Deploy to Pipecat Cloud\" during project creation, the necessary Docker and deployment config files are automatically generated.\n\nLearn more in the [Pipecat Cloud documentation](https://docs.pipecat.ai/deployment/pipecat-cloud/introduction).\n\n## \ud83d\udcda Next steps\n\n- See the [Pipecat documentation](https://docs.pipecat.ai) for more about building bots\n- Learn how to extend the template using [examples & recipes](https://docs.pipecat.ai/examples)\n- [Join our Discord](https://discord.gg/pipecat) to get help or provide feedback\n",
"bugtrack_url": null,
"license": null,
"summary": "CLI tool for scaffolding Pipecat AI voice agent projects",
"version": "0.1.0",
"project_urls": {
"Issues": "https://github.com/pipecat-ai/pipecat-cli/issues",
"Source": "https://github.com/pipecat-ai/pipecat-cli",
"Website": "https://pipecat.ai"
},
"split_keywords": [
"pipecat",
" ai",
" cli",
" voice",
" agents",
" scaffolding"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0641e239db103275d09cca5263d1f8d251b6f63b3d22b8c45f1e40d54c206f8a",
"md5": "b084582c4f8582a23e295b89228cc87a",
"sha256": "fe7ae04583b41ffd0c2363f25899038b2fcbd93818c2dfc87cc9061c5154eb06"
},
"downloads": -1,
"filename": "pipecat_ai_cli-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b084582c4f8582a23e295b89228cc87a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 64060,
"upload_time": "2025-10-18T00:29:12",
"upload_time_iso_8601": "2025-10-18T00:29:12.442299Z",
"url": "https://files.pythonhosted.org/packages/06/41/e239db103275d09cca5263d1f8d251b6f63b3d22b8c45f1e40d54c206f8a/pipecat_ai_cli-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4644cf1e357fd6d61932cff89e2b6375b481524a376450cd6894ab1702ffdaf7",
"md5": "2efcec4f876919d3a9741214a9678443",
"sha256": "89a43db1bc677bf77d841b17a6aebc382cb4d5fcac5c238642b02c2bdc039428"
},
"downloads": -1,
"filename": "pipecat_ai_cli-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "2efcec4f876919d3a9741214a9678443",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 326329,
"upload_time": "2025-10-18T00:29:13",
"upload_time_iso_8601": "2025-10-18T00:29:13.999369Z",
"url": "https://files.pythonhosted.org/packages/46/44/cf1e357fd6d61932cff89e2b6375b481524a376450cd6894ab1702ffdaf7/pipecat_ai_cli-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-18 00:29:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pipecat-ai",
"github_project": "pipecat-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pipecat-ai-cli"
}
JSON
