Skip to main content
The auth command group manages authentication with Pipecat Cloud, allowing you to login, logout, and check your current account identity.

​
login

Begins an authorization flow to authenticate with Pipecat Cloud. Usage:
This command initiates the authentication process by:
  1. Generating a unique authentication URL
  2. Opening your default web browser (if available)
  3. Waiting for you to complete the sign-in process in the browser
  4. Retrieving and storing your access token locally
If the browser doesn’t open automatically, you can copy and paste the displayed URL into your browser manually. On successful login, the CLI will store the access token in the local configuration file (defaults to ~/.config/pipecatcloud/pipecatcloud.toml). This token will be used for all subsequent requests to the Pipecat Cloud API. You can override the default location by setting the PIPECAT_CONFIG_PATH environment variable.

​
logout

Signs out of the current Pipecat Cloud account by removing the access token from your local configuration file. Usage:

​
use-pat

Authenticates with a Personal Access Token instead of interactive OAuth login. Validates the token against the API and stores it in your local config file. Usage:
The command prompts for the token without echoing it, so it takes no arguments. Without a terminal it reads the token from stdin. In CI, set PIPECAT_TOKEN instead.
You can also set the PIPECAT_TOKEN environment variable instead of storing the token locally. See the PAT guide for details.

​
whoami

Displays information about the currently authenticated user, including your email (or user ID when the account has no email), active organization, auth method, and Daily API key. Usage:

​
Configuration

CLI configuration is stored in ~/.config/pipecatcloud/pipecatcloud.toml. You can override this location by setting the PIPECAT_CONFIG_PATH environment variable. The configuration stores your access token, active organization, and default API keys. View current configuration:
We do not recommend manually editing the configuration file. If the file becomes malformed, run pipecat cloud auth login to regenerate it.

More about user accounts

Managing your account and collaborating on agents as part of a team