Skip to main content
Create, deploy, and manage voice agents from the command line.

​
Installation

By running the quick install commands, you are accepting Cartesia’s Terms of Service (TOS). Please make sure to review the full TOS here before proceeding.
Install and download from our servers: 
curl -fsSL https://cartesia.sh | sh
Update to the latest version: 
cartesia update

​
Quick Start

1

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.
cartesia auth login  # paste your API key when prompted
2

Clone an example agent

Clone an example agent from the Line repository.
cartesia create my-agent
# Choose any example you like.
cd my-agent
3

Initialize your agent

Give your agent a name and link it to your organization.
cartesia init
4

Deploy your agent

Deploy your agent to make it available in the playground.
cartesia deploy

​
Features

​
Initialize a Project

Link any directory to a new or existing Cartesia agent: 
cartesia init
Create a project from an example: 
cartesia create
Inside a project directory, the CLI auto-detects the agent. Run cartesia status to see the current agent ID.

​
Chat with Your Agent

Test your agent’s text reasoning locally. Terminal 1. Run your text logic fastapi server: 
PORT=8000 uv run python main.py
Terminal 2. Run the CLI to chat with your agent: 
cartesia chat 8000

​
Commands

​
Authentication

To get an API key, go to play.cartesia.ai/keys, select your organization, and generate a new key. 
cartesia auth login
To validate the existing API key: 
cartesia auth status
To logout (clears cached credentials): 
cartesia auth logout

​
Voice Agents

Deploy your agent to Cartesia cloud. 
cartesia deploy
List out all the agents in your organization: 
cartesia agents ls

​
Deployments

Versions of your agent running on Cartesia’s cloud. Each deployment rebuilds the environment, instantiates your project, and runs a health check. To see all of your deployments: 
cartesia deployments ls
Check the status of a deployment: 
cartesia status [<deployment-id> or <agent-id>]

​
Environment Variables

Create, list, and remove environment variables for your agent. Set environment variables for your agent: 
cartesia env set API_KEY=FOOBAR MY_CONFIG=FOOBAZ
Environment variables are encrypted for storage and can only be accessed by your code.
Port environment variables from a .env file: 
cartesia env set --from .env
.env
API_KEY=FOOBAR
MY_CONFIG=FOOBAZ
Remove an environment variable: 
cartesia env rm <env-var-name>

​
Help Menu

For more details on any command: 
cartesia --help