From 71ebb0c84387ba4a94b923af78eb17692767a3da Mon Sep 17 00:00:00 2001 From: Trayan Azarov Date: Thu, 25 Jan 2024 14:40:22 +0200 Subject: [PATCH] docs: Added initial CLI docs Refs: chroma-core/chroma#1638 --- docs/cli.md | 39 +++++++++++++++++++++++++++++++++++++++ sidebars.js | 1 + 2 files changed, 40 insertions(+) create mode 100644 docs/cli.md diff --git a/docs/cli.md b/docs/cli.md new file mode 100644 index 0000000..72d6049 --- /dev/null +++ b/docs/cli.md @@ -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 +``` diff --git a/sidebars.js b/sidebars.js index 62c6fd8..76bb166 100644 --- a/sidebars.js +++ b/sidebars.js @@ -27,6 +27,7 @@ const sidebars = { label: '🧬 Embeddings', className: 'category-link', }, + 'cli', 'multi-modal', 'api-reference', 'troubleshooting',