Skip to content
This repository has been archived by the owner on May 10, 2024. It is now read-only.

docs: Added initial CLI docs #207

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
sidebar_label: 💻 CLI
title: CLI
sidebar_position: 10
---

# Chroma Command Line Interface (CLI)

The Chroma CLI is a command line interface for interacting with Chroma.

The CLI comes with Chroma core package and is available in your virtual environment after installing Chroma (`pip install chromadb`).

## Usage

Available CLI commands are:

- `run` - Run Chroma DB server locally

### Run


- `--path` - Path to the Chroma DB directory. If not provided, the current working directory is used.
- `--host` - Host to run the server on. Default: `localhost`
- `--port` - Port to run the server on. Default: `8000`
- `--log-path` - Path to the log file. Default: `chroma.log`


Example:

```bash
chroma run --path /chroma-data --host 0.0.0.0 --port 8000 --log-path chroma.log
```

### Help


```bash
chroma --help
```
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ const sidebars = {
label: '🧬 Embeddings',
className: 'category-link',
},
'cli',
'multi-modal',
'api-reference',
'troubleshooting',
Expand Down