@vivantel/virage-store-chromadb
v0.2.25
Published
ChromaDB vector store for @vivantel/rag-core (local or hosted)
Maintainers
Readme
@vivantel/virage-store-chromadb
ChromaDB vector store for @vivantel/virage-core. Works with a locally-running Chroma server or hosted Chroma Cloud.
Installation
npm install @vivantel/virage-store-chromadb @vivantel/virage-coreQuick start (JSON config)
Local Chroma server:
{
"vectorStore": {
"package": "@vivantel/virage-store-chromadb",
"config": {
"path": "http://localhost:8000"
}
}
}Running Chroma locally
docker run -p 8000:8000 chromadb/chromaHosted Chroma
Pass your Chroma Cloud URL and API key:
{
"vectorStore": {
"package": "@vivantel/virage-store-chromadb",
"config": {
"path": "${CHROMA_URL}",
"apiKey": "${CHROMA_API_KEY}"
}
}
}Configuration
| Option | Type | Default | Description |
| ---------------- | -------- | ------------------------- | --------------------------------------------------- |
| path | string | "http://localhost:8000" | Chroma server URL |
| apiKey | string | undefined | API key for hosted Chroma (token auth) |
| collectionName | string | "documents" | Collection name |
| dimensions | number | undefined | Vector size (inferred from first upsert if omitted) |
TypeScript usage
import { ChromaVectorStore } from "@vivantel/virage-store-chromadb";
const store = new ChromaVectorStore({
path: "http://localhost:8000",
collectionName: "my-docs",
});Self-registration
This package declares a "rag-plugin" field in its package.json. Once installed, virage init discovers it automatically — no manual config required.
// package.json (excerpt)
"rag-plugin": {
"type": "vectorStore",
"label": "ChromaDB (local or hosted)",
"key": "chromadb",
"envVars": [],
"defaultConfig": { "path": "http://localhost:8000" }
}