Chromadb-cli NPM

Basic CLI to interact with ChromaDB server ChromaDB

Developed using oclif. For contribution guidelines and development details, head over there.

Usage

$ npm install -g chromadb-cli
$ chromadb COMMAND
running command...
$ chromadb (--version)
chromadb-cli/0.1.2 darwin-arm64 node-v18.16.0
$ chromadb --help [COMMAND]
USAGE
  $ chromadb COMMAND
...

Initialization

Start by configuring the CLI.

$ chromadb configure

The CLI can use ENV vars as well, just set CHROME_SERVER_HOST and CHROME_SERVER_PORT.

Note: it does not support authentication as of now. PRs welcome :)

Commands

`chromadb collections delete COLLECTION_NAME`

delete a collection

USAGE
  $ chromadb collections delete COLLECTION_NAME

ARGUMENTS
  COLLECTION_NAME  name of the collection

DESCRIPTION
  delete a collection

EXAMPLES
  $ chromadb collections delete

See code: dist/commands/collections/delete.ts

`chromadb collections get COLLECTION_NAME`

get a collection

USAGE
  $ chromadb collections get COLLECTION_NAME

ARGUMENTS
  COLLECTION_NAME  name of the collection

DESCRIPTION
  get a collection

EXAMPLES
  $ chromadb collections get

See code: dist/commands/collections/get.ts

`chromadb collections list`

list collections in the chroma server

USAGE
  $ chromadb collections list

DESCRIPTION
  list collections in the chroma server

EXAMPLES
  $ chromadb collections list

See code: dist/commands/collections/list.ts

`chromadb configure`

set configuration for the chromadb server

USAGE
  $ chromadb configure

DESCRIPTION
  set configuration for the chromadb server

See code: dist/commands/configure.ts

`chromadb help [COMMANDS]`

Display help for chromadb.

USAGE
  $ chromadb help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for chromadb.

See code: @oclif/plugin-help

`chromadb items count COLLECTION_NAME`

count items in a collection

USAGE
  $ chromadb items count COLLECTION_NAME

ARGUMENTS
  COLLECTION_NAME  name of the collection

DESCRIPTION
  count items in a collection

EXAMPLES
  $ chromadb items count

See code: dist/commands/items/count.ts

`chromadb items get COLLECTION_NAME ITEM_ID`

get item in a collection

USAGE
  $ chromadb items get COLLECTION_NAME ITEM_ID

ARGUMENTS
  COLLECTION_NAME  name of the collection
  ITEM_ID          id of the item

DESCRIPTION
  get item in a collection

EXAMPLES
  $ chromadb items get

See code: dist/commands/items/get.ts

`chromadb items peek COLLECTION_NAME`

count items in a collection

USAGE
  $ chromadb items peek COLLECTION_NAME [--limit <value>]

ARGUMENTS
  COLLECTION_NAME  name of the collection

FLAGS
  --limit=<value>  [default: 10] how many items to return

DESCRIPTION
  count items in a collection

EXAMPLES
  $ chromadb items peek

See code: dist/commands/items/peek.ts

`chromadb items query COLLECTION_NAME TEXT`

query items in a collection

USAGE
  $ chromadb items query COLLECTION_NAME TEXT [--provider openai] [--model text-embedding-ada-002] [--limit
    <value>]

ARGUMENTS
  COLLECTION_NAME  name of the collection
  TEXT             text to query for

FLAGS
  --limit=<value>      [default: 10] how many items to return
  --model=<option>     [default: text-embedding-ada-002] what model to use
                       <options: text-embedding-ada-002>
  --provider=<option>  [default: openai] what LLM provider to use
                       <options: openai>

DESCRIPTION
  query items in a collection

EXAMPLES
  $ chromadb items query

See code: dist/commands/items/query.ts

`chromadb update [CHANNEL]`

update the chromadb CLI

USAGE
  $ chromadb update [CHANNEL] [-a] [-v <value> | -i] [--force]

FLAGS
  -a, --available        Install a specific version.
  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
  -v, --version=<value>  Install a specific version.
  --force                Force a re-download of the requested version.

DESCRIPTION
  update the chromadb CLI

EXAMPLES
  Update to the stable channel:

    $ chromadb update stable

  Update to a specific version:

    $ chromadb update --version 1.0.0

  Interactively select version:

    $ chromadb update --interactive

  See available versions:

    $ chromadb update --available

See code: @oclif/plugin-update