Quickstart to use Pipecat CLI

This commit is contained in:
Mark Backman
2025-10-21 15:52:27 -04:00
parent a479c32665
commit 52ab0eccc0
4 changed files with 26 additions and 10 deletions

View File

@@ -110,7 +110,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
`UserStartedSpeakingFrame` and `UserStoppedSpeakingFrame` messages. `UserStartedSpeakingFrame` and `UserStoppedSpeakingFrame` messages.
- Fixed an issue in `RivaSegmentedSTTService` where a runtime error occurred due - Fixed an issue in `RivaSegmentedSTTService` where a runtime error occurred due
to a mismatch in the _handle_transcription method's signature. to a mismatch in the `_handle_transcription` method's signature.
- Fixed multiple pipeline task cancellation issues. `asyncio.CancelledError` is - Fixed multiple pipeline task cancellation issues. `asyncio.CancelledError` is
now handled properly in `PipelineTask` making it possible to cancel an asyncio now handled properly in `PipelineTask` making it possible to cancel an asyncio

View File

@@ -73,13 +73,13 @@ Transform your local bot into a production-ready service. Pipecat Cloud handles
1. [Sign up for Pipecat Cloud](https://pipecat.daily.co/sign-up). 1. [Sign up for Pipecat Cloud](https://pipecat.daily.co/sign-up).
2. Install the Pipecat Cloud CLI: 2. Install the Pipecat CLI:
```bash ```bash
uv add pipecatcloud uv tool install pipecat-ai-cli
``` ```
> 💡 Tip: You can run the `pipecatcloud` CLI using the `pcc` alias. > 💡 Tip: You can run the `pipecat` CLI using the `pc` alias.
3. Set up Docker for building your bot image: 3. Set up Docker for building your bot image:
@@ -113,12 +113,22 @@ secret_set = "quickstart-secrets"
> 💡 Tip: [Set up `image_credentials`](https://docs.pipecat.ai/deployment/pipecat-cloud/fundamentals/secrets#image-pull-secrets) in your TOML file for authenticated image pulls > 💡 Tip: [Set up `image_credentials`](https://docs.pipecat.ai/deployment/pipecat-cloud/fundamentals/secrets#image-pull-secrets) in your TOML file for authenticated image pulls
### Log in to Pipecat Cloud
To start using the CLI, authenticate to Pipecat Cloud:
```bash
pipecat cloud auth login
```
You'll be presented with a link that you can click to authenticate your client.
### Configure secrets ### Configure secrets
Upload your API keys to Pipecat Cloud's secure storage: Upload your API keys to Pipecat Cloud's secure storage:
```bash ```bash
uv run pcc secrets set quickstart-secrets --file .env pipecat cloud secrets set quickstart-secrets --file .env
``` ```
This creates a secret set called `quickstart-secrets` (matching your TOML file) and uploads all your API keys from `.env`. This creates a secret set called `quickstart-secrets` (matching your TOML file) and uploads all your API keys from `.env`.
@@ -128,13 +138,13 @@ This creates a secret set called `quickstart-secrets` (matching your TOML file)
Build your Docker image and push to Docker Hub: Build your Docker image and push to Docker Hub:
```bash ```bash
uv run pcc docker build-push pipecat cloud docker build-push
``` ```
Deploy to Pipecat Cloud: Deploy to Pipecat Cloud:
```bash ```bash
uv run pcc deploy pipecat cloud deploy
``` ```
### Connect to your agent ### Connect to your agent

View File

@@ -1,6 +1,11 @@
agent_name = "quickstart" agent_name = "quickstart"
image = "your_username/quickstart:0.1" image = "your_username/quickstart:0.1"
secret_set = "quickstart-secrets" secret_set = "quickstart-secrets"
agent_profile = "agent-1x"
# RECOMMENDED: Set an image pull secret:
# https://docs.pipecat.ai/deployment/pipecat-cloud/fundamentals/secrets#image-pull-secrets
# image_credentials = "your_image_pull_secret"
[scaling] [scaling]
min_agents = 1 min_agents = 1

View File

@@ -4,13 +4,14 @@ version = "0.1.0"
description = "Quickstart example for building voice AI bots with Pipecat" description = "Quickstart example for building voice AI bots with Pipecat"
requires-python = ">=3.10" requires-python = ">=3.10"
dependencies = [ dependencies = [
"pipecat-ai[webrtc,daily,silero,deepgram,openai,cartesia,local-smart-turn-v3,runner]>=0.0.86", "pipecat-ai[webrtc,daily,silero,deepgram,openai,cartesia,local-smart-turn-v3,runner]",
"pipecatcloud>=0.2.4" "pipecat-ai-cli"
] ]
[dependency-groups] [dependency-groups]
dev = [ dev = [
"ruff~=0.12.1", "pyright>=1.1.404,<2",
"ruff>=0.12.11,<1",
] ]
[tool.ruff] [tool.ruff]