Installation
chroma command.
Global Options
Commands Overview
run
Start a local Chroma server
db
Manage Chroma Cloud databases
browse
Browse collections interactively
copy
Copy collections between environments
login
Log in to Chroma Cloud
profile
Manage Chroma Cloud profiles
vacuum
Vacuum a local database
install
Install sample applications
run
Start a local Chroma server.Arguments
config_path- Path to a Chroma config file (optional)
Options
The persistence path to your Chroma DB. Cannot be used with
config_path.The host to listen to. Cannot be used with
config_path.The port to run the server on. Cannot be used with
config_path.Examples
Output
When the server starts successfully, you’ll see:- Chroma logo
- Data storage path
- Server URL
- Getting started guide link
- Chroma Cloud signup information
db (Database Management)
Manage Chroma Cloud databases.Subcommands
db create
Create a new database in Chroma Cloud.name- The name of the DB to create (optional, will prompt if not provided)
--dev- Flag to use during development (hidden)
db list
List all available databases.--dev- Flag to use during development (hidden)
db connect
Generate a connection snippet for a database.name- The name of the DB to connect to (optional, will prompt if not provided)
Programming language for the connection snippet. Options:
python, javascript, typescriptAdd Chroma environment variables to a
.env file in the current directory. Cannot be used with --language or --env-vars.Output Chroma environment variables. Cannot be used with
--language or --env-file.db delete
Delete a database.name- The name of the DB to delete (optional, will prompt if not provided)
--force- Delete without confirmation (hidden)--dev- Flag to use during development (hidden)
browse
Browse Chroma collections with an interactive TUI (Terminal User Interface).Arguments
collection_name- The name of the collection to browse (required)
Options
The Chroma Cloud DB name with your collection
Find this collection on a local Chroma server
Theme for the collection browser. Options:
Dark, LightThe hostname for your local Chroma server. Cannot be used with
--path.The data path for your local Chroma server. Cannot be used with
--host.Examples
copy
Copy collections between local and Chroma Cloud environments.Options
Copy all collections. Cannot be used with
--collections.The names of collections to copy. Can be specified multiple times.
Copy from a local Chroma server. Cannot be used with
--from-cloud or --to-local.Copy from Chroma Cloud. Cannot be used with
--to-cloud or --from-local.Copy to a local Chroma server. Cannot be used with
--to-cloud.Copy to Chroma Cloud.
Chroma Cloud DB with the collections to copy
Local Chroma server host. Cannot be used with
--path.Data path for your local Chroma server. Cannot be used with
--host.Batch size for records when copying. Min: 1, Max: 300.
Number of concurrent processes when copying. Min: 1, Max: 8.
Examples
The copy command performs a one-time copy operation. Collections must not already exist in the target environment.
login
Log in to Chroma Cloud.Options
Profile name to associate with auth credentials
API key for headless authentication. When used with
--profile, enables headless login.Flag to use during development (hidden)
Examples
Interactive Login Flow
- Opens your browser to Chroma Cloud
- Authenticate with your account
- Select team (if you belong to multiple)
- Credentials are saved to
~/.chroma/credentials - Profile is set as active
profile
Manage Chroma Cloud profiles.Subcommands
profile list
List all available profiles.profile show
Show the current active profile.profile use
Set the active profile.name- The name of the profile to use (required)
profile delete
Delete a profile.name- The name of the profile to delete (required)
--force- Skip delete confirmation for the active profile
profile rename
Rename a profile.name- The name of the profile to rename (required)new_name- The new name for the profile (required)
vacuum
Vacuum a local Chroma persistent directory to reclaim disk space.Options
The path of your Chroma DB
Skip vacuum confirmation
Maximum time (in seconds) to wait for vacuum
Examples
If you upgraded from Chroma version below 0.5.6 to 0.5.6 or above, run vacuum once to greatly reduce database size and enable continuous database pruning.
install
Install sample applications from the Chroma repository.Arguments
name- The name of the sample app to install (optional, will prompt if not provided)
Options
List all available sample apps. Cannot be used with
name or --local.Configure the app for local Chroma server
Database name to use (required for cloud mode)
Examples
update
Check for Chroma CLI updates.docs
Open the Chroma online documentation.support
Open the Chroma Discord community.Environment Variables
The CLI respects several environment variables:CHROMA_API_KEY- API key for Chroma CloudCHROMA_TENANT- Tenant IDCHROMA_DATABASE- Database namePOSTGRES_HOST- PostgreSQL host (for Go backend development)POSTGRES_PORT- PostgreSQL port (for Go backend development)
Configuration Files
CLI configuration is stored in~/.chroma/:
credentials- Stored profile credentialsconfig.json- CLI configuration and preferences