CLI documentation
Overview
Cartesia’s CLI enables developers to create, deploy and manage their Voice Agents through the command line.
Installation
Install and download from our servers:
And ask the CLI to self update:
Quick Start
Login with API key
Authenticate with your Cartesia API key. To make an API key, go to play.cartesia.ai/keys and select your organization.
Features
Initialize a Project
Link any directory to a new or existing Cartesia agent:
Create a project from a template:
When are you working inside a project directory, the CLI will automatically detect the agent.
You can skip passing --agent-id
argument.
Run cartesia status
to see the current agent id.
Chat with Your Agent
Test the text reasoning logic for your voice agent locally.
Terminal 1. Run your text logic fastapi server:
Terminal 2. Run the CLI to chat with your agent:
Commands
Authentication
To get an API key, go to play.cartesia.ai/keys, select your organization, and generate a new key.
To validate the existing API key:
To logout (clears cached credentials):
Voice Agents
Deploy your agent to Cartesia cloud.
List out all the agents in your organization:
Deployments
Deployments are versions of your agent running on Cartesia’s cloud. When we receive a new deployment, cartesia servers will rebuild the virtual environment, instantiate your project, and perform a health check to ensure it is ready to receive calls.
To see all of your deployments:
Check the status of a deployment:
Environment Variables
Create, list, and remove environment variables for your agent.
Set environment variables for your agent:
Environment variables are encrypted for storage and can only be accessed by your code.
Port environment variables from a .env
file:
Remove an environment variable:
Help Menu
For more details on any command: