{"_id":"chroma-db-workbench","_rev":"4-5c7311e7fbd8a50c2d744c9eafda2778","name":"chroma-db-workbench","dist-tags":{"latest":"0.1.6"},"versions":{"0.1.3":{"name":"chroma-db-workbench","version":"0.1.3","keywords":["chroma","chromadb","vector-database","vector-db","rag","semantic-search","ai","llm","embeddings","chroma-workbench","chroma-explorer","vector-explorer","database-explorer","collections-browser","query-tool","devtools","gui","cli","npx"],"author":{"name":"Harish Kaparwan"},"license":"MIT","_id":"chroma-db-workbench@0.1.3","maintainers":[{"name":"harishkaparwan","email":"hkaparwan@my365.bellevue.edu"}],"homepage":"https://harishkaparwan.github.io/chroma-db-web/","bugs":{"url":"https://github.com/harishkaparwan/chroma-db-workbench/issues"},"bin":{"chroma-db-workbench":"bin/cli.js"},"dist":{"shasum":"633e55a4b773c796d8689606d3205de40452d945","tarball":"https://registry.npmjs.org/chroma-db-workbench/-/chroma-db-workbench-0.1.3.tgz","fileCount":15,"integrity":"sha512-o6tcQiMjDXzHo8YkNegC23U+ncTZX1pgg7yBjqvHZXos6PdiiLKDl6lJ6bEnlJZ28bYOl1GpZJvdPK9QUhmL8Q==","signatures":[{"sig":"MEUCIQDOrg9lRmHvR6r07LqYHtJ9m0tlcBj7PsLzFSBtpLk8JgIgMRSMXBfyVeGQQmwDovOMGYXsnFZk9FdOBuJbjKazOcA=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":655546},"main":"bin/cli.js","private":false,"scripts":{"start":"node bin/cli.js","sync-ui":"node scripts/sync-ui.mjs","stage:publish":"npm run sync-ui && npm stage publish","prepublishOnly":"npm run sync-ui","sync-ui:no-build":"node scripts/sync-ui.mjs --no-build"},"_npmUser":{"name":"harishkaparwan","email":"hkaparwan@my365.bellevue.edu"},"repository":{"url":"git+https://github.com/harishkaparwan/chroma-db-workbench.git","type":"git"},"_npmVersion":"11.15.0","description":"Zero-config Chroma Workbench — AI-native vector database GUI. Collections browser, semantic search, metadata explorer, embeddings viewer & query console. Run with one `npx chroma-workbench`","directories":{},"_nodeVersion":"22.22.3","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/chroma-db-workbench_0.1.3_1781177630330_0.8634574600917801","host":"s3://npm-registry-packages-npm-production"}},"0.1.4":{"name":"chroma-db-workbench","version":"0.1.4","keywords":["chroma","chromadb","chroma-db","chroma-db-workbench","chroma-db-explorer","chroma-db-extension","chroma-db-tool","chroma-db-plugin","vector-database","vector-db","rag","semantic-search","ai","llm","embeddings","chroma-workbench","chroma-explorer","vector-explorer","database-explorer","collections-browser","query-tool","devtools","gui","cli","npx"],"author":{"name":"Harish Kaparwan"},"license":"MIT","_id":"chroma-db-workbench@0.1.4","maintainers":[{"name":"harishkaparwan","email":"hkaparwan@my365.bellevue.edu"}],"homepage":"https://harishkaparwan.github.io/chroma-db-web/","bugs":{"url":"https://github.com/harishkaparwan/chroma-db-workbench/issues"},"bin":{"chroma-db-workbench":"bin/cli.js"},"dist":{"shasum":"942c13344377ecd8267737e0dd3ccc2dead11023","tarball":"https://registry.npmjs.org/chroma-db-workbench/-/chroma-db-workbench-0.1.4.tgz","fileCount":15,"integrity":"sha512-ewKZ7J47DO5OijQXncXdlL8ZTrAedgawx1Xhn4Koai8bpSTpUcbBGhDQdFaNCtWMfD1yMnxmYFiIgNDxgFuySw==","signatures":[{"sig":"MEUCIDNUSkPny9SEyCCeTiZpBqV2vz9XMmPz0CK7mVgU2xzXAiEAipidHIWlKEaTVKjWfZxNaAf4lzY9EmGeecnDrdQrUeU=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":656046},"main":"bin/cli.js","private":false,"scripts":{"start":"node bin/cli.js","sync-ui":"node scripts/sync-ui.mjs","stage:publish":"npm run sync-ui && npm stage publish","prepublishOnly":"npm run sync-ui","sync-ui:no-build":"node scripts/sync-ui.mjs --no-build"},"_npmUser":{"name":"harishkaparwan","email":"hkaparwan@my365.bellevue.edu"},"repository":{"url":"git+https://github.com/harishkaparwan/chroma-db-workbench.git","type":"git"},"_npmVersion":"11.15.0","description":"Zero-config Chroma DB Workbench — AI-native vector database GUI. Collections browser, semantic search, metadata explorer, embeddings viewer & query console. Run with one `npx chroma-db-workbench`","directories":{},"_nodeVersion":"22.22.3","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/chroma-db-workbench_0.1.4_1781179361686_0.8894975476887386","host":"s3://npm-registry-packages-npm-production"}},"0.1.5":{"name":"chroma-db-workbench","version":"0.1.5","keywords":["chroma","chromadb","chroma-db","chroma-db-workbench","chroma-db-explorer","chroma-db-extension","chroma-db-workbench-cli","chroma-db-workbench-tool","chorma-client","chroma-db-tool","chroma-db-plugin","vector-database","chroma-db-workbench","chroma-db-explorer","chroma-db-extension","chroma-db-tool","chroma-db-plugin","vector-database","chroma-client","chroma-client-sdk","chroma-client-library","vector-db","rag","semantic-search","ai","llm","embeddings","chroma-workbench","chroma-explorer","vector-explorer","database-explorer","collections-browser","query-tool","devtools","gui","cli","npx"],"author":{"name":"Harish Kaparwan"},"license":"MIT","_id":"chroma-db-workbench@0.1.5","maintainers":[{"name":"harishkaparwan","email":"hkaparwan@my365.bellevue.edu"}],"homepage":"https://harishkaparwan.github.io/chroma-db-web/","bugs":{"url":"https://github.com/harishkaparwan/chroma-db-workbench/issues"},"bin":{"chroma-db-workbench":"bin/cli.js"},"dist":{"shasum":"2a4b72b8ade75f5d5be93aa132e616c62e5f3e6d","tarball":"https://registry.npmjs.org/chroma-db-workbench/-/chroma-db-workbench-0.1.5.tgz","fileCount":15,"integrity":"sha512-A4xxWUVS3DY8YzD+JXOJG+hkIdFlToMa+jKs94Zc5DLt405iWvPMXH415Wjpc3sLsfpMfAlmlrZQwUj38WQ4tw==","signatures":[{"sig":"MEUCICeJzoDwYeuRheukOz7Aqsf494oSQfyrVck1YJNdyd0mAiEArznz8zsMd6DM3nYg5H4YOTudxySz35K7dnzZBvrV+W4=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":656354},"main":"bin/cli.js","private":false,"scripts":{"start":"node bin/cli.js","sync-ui":"node scripts/sync-ui.mjs","stage:publish":"npm run sync-ui && npm stage publish","prepublishOnly":"npm run sync-ui","sync-ui:no-build":"node scripts/sync-ui.mjs --no-build"},"_npmUser":{"name":"harishkaparwan","email":"hkaparwan@my365.bellevue.edu"},"repository":{"url":"git+https://github.com/harishkaparwan/chroma-db-workbench.git","type":"git"},"_npmVersion":"11.15.0","description":"Zero-config Chroma DB Workbench — AI-native vector database GUI. Collections browser, semantic search, metadata explorer, embeddings viewer & query console. Run with one `npx chroma-db-workbench`","directories":{},"_nodeVersion":"22.22.3","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/chroma-db-workbench_0.1.5_1781215013615_0.3250542544520587","host":"s3://npm-registry-packages-npm-production"}},"0.1.6":{"name":"chroma-db-workbench","version":"0.1.6","description":"Zero-Config Chroma DB Workbench — An AI-native GUI for the Chroma vector database.Browse collections, perform semantic search, explore metadata, visualize embeddings, and interact with a powerful query console — all without any configuration.  Launch inst","private":false,"main":"bin/cli.js","bin":{"chroma-db-workbench":"bin/cli.js"},"scripts":{"start":"node bin/cli.js","sync-ui":"node scripts/sync-ui.mjs","sync-ui:no-build":"node scripts/sync-ui.mjs --no-build","stage:publish":"npm run sync-ui && npm stage publish","prepublishOnly":"npm run sync-ui"},"keywords":["trychroma","try-chroma","Chroma","chroma","Chroma-database","chroma-db","chroma-vector-db","chroma-db-workbench","chroma-db-explorer","chroma-db-extension","chroma-db-workbench-cli","chroma-db-workbench-tool","chorma-db-client","chroma-db-tool","chroma-db-plugin","vector-database","chroma-db-tool","chroma-db-plugin","vector-database","chroma-client","chroma-client-sdk","chroma-client-library","vector-db","rag","semantic-search","ai","llm","embeddings","chroma-workbench","chroma-explorer","vector-explorer","database-explorer","collections-browser","query-tool","devtools","gui","cli","npx"],"author":{"name":"Harish Kaparwan"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/harishkaparwan/chroma-db-workbench.git"},"bugs":{"url":"https://github.com/harishkaparwan/chroma-db-workbench/issues"},"homepage":"https://harishkaparwan.github.io/chroma-db-web/","publishConfig":{"access":"public"},"_id":"chroma-db-workbench@0.1.6","_nodeVersion":"22.22.3","_npmVersion":"11.15.0","dist":{"integrity":"sha512-0Gh3BCr8WpxqApVgmcFCuAMj+rSSBGNBBTMiD1ftl4ySWRL9V9mARYwS3Vx7daxoXDPGnwJaI4NjFMLMo2ht4w==","shasum":"a0343aa26f99b4f680e4944056cfc4b9d52ed9b8","tarball":"https://registry.npmjs.org/chroma-db-workbench/-/chroma-db-workbench-0.1.6.tgz","fileCount":15,"unpackedSize":656493,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIDmYJkTPN1M0SDwvQ9K/U3KChq5F9htVf25pT4UNbmuRAiEAlSLJXdk6BCuiwfVhn0uTMDUiU9/nlQXcJAnhI7MfL9Y="}]},"_npmUser":{"name":"harishkaparwan","email":"hkaparwan@my365.bellevue.edu"},"directories":{},"maintainers":[{"name":"harishkaparwan","email":"hkaparwan@my365.bellevue.edu"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/chroma-db-workbench_0.1.6_1781359705158_0.9047269761929915"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-11T11:33:50.110Z","modified":"2026-06-13T14:08:25.549Z","0.1.3":"2026-06-11T11:33:50.523Z","0.1.4":"2026-06-11T12:02:41.856Z","0.1.5":"2026-06-11T21:56:53.827Z","0.1.6":"2026-06-13T14:08:25.426Z"},"bugs":{"url":"https://github.com/harishkaparwan/chroma-db-workbench/issues"},"author":{"name":"Harish Kaparwan"},"license":"MIT","homepage":"https://harishkaparwan.github.io/chroma-db-web/","keywords":["trychroma","try-chroma","Chroma","chroma","Chroma-database","chroma-db","chroma-vector-db","chroma-db-workbench","chroma-db-explorer","chroma-db-extension","chroma-db-workbench-cli","chroma-db-workbench-tool","chorma-db-client","chroma-db-tool","chroma-db-plugin","vector-database","chroma-db-tool","chroma-db-plugin","vector-database","chroma-client","chroma-client-sdk","chroma-client-library","vector-db","rag","semantic-search","ai","llm","embeddings","chroma-workbench","chroma-explorer","vector-explorer","database-explorer","collections-browser","query-tool","devtools","gui","cli","npx"],"repository":{"type":"git","url":"git+https://github.com/harishkaparwan/chroma-db-workbench.git"},"description":"Zero-Config Chroma DB Workbench — An AI-native GUI for the Chroma vector database.Browse collections, perform semantic search, explore metadata, visualize embeddings, and interact with a powerful query console — all without any configuration.  Launch inst","maintainers":[{"name":"harishkaparwan","email":"hkaparwan@my365.bellevue.edu"}],"readme":"<div align=\"center\">\n\n<img src=\"https://harishkaparwan.github.io/chroma-db-web/public/assets/chroma-db-logo.png\" width=\"210\" alt=\"Chroma DB Workbench\" />\n\n# Chroma DB Workbench\n\n### Administer Chroma tenants, collections, and APIs — one `npx` away\n\n**Inspect tenants · Explore collections · Run record actions · Debug raw REST calls.**\n\n<br/>\n\n[![npm version](https://img.shields.io/npm/v/chroma-db-workbench?label=npm&color=cb3837&logo=npm&logoColor=white)](https://www.npmjs.com/package/chroma-db-workbench)\n[![npm downloads](https://img.shields.io/npm/dm/chroma-db-workbench?label=Downloads&color=cb3837&logo=npm&logoColor=white)](https://www.npmjs.com/package/chroma-db-workbench)\n[![Node](https://img.shields.io/badge/Node-%3E%3D18-339933?logo=node.js&logoColor=white)](https://nodejs.org)\n[![License: MIT](https://img.shields.io/badge/License-MIT-22c55e)](./LICENSE)\n\n</div>\n\n---\n\n## 🧩 Also Available as a VS Code Extension\n\n> **Prefer working inside your editor?** Get the same workbench as a full sidebar panel in VS Code.\n\n**[Install from Marketplace](https://marketplace.visualstudio.com/items?itemName=HarishKaparwan.chroma-db)**  \nFull sidebar workbench natively inside your editor. Browse collections, run queries, inspect records, and send raw HTTP commands — zero setup required.\n\n**Also on [Open VSX](https://open-vsx.org/extension/harishkaparwan/chroma-db)**\n\n---\n\n## Overview\n\n**Chroma DB Workbench** bundles the production Chroma admin UI inside a zero-dependency Node CLI. It launches a tiny HTTP server, injects your preferred endpoint + credentials before the page loads, and opens the workbench in your browser in seconds.\n\nNo clone. No build. No dependencies. Just `npx`.\n\n```bash\nnpx chroma-db-workbench\n```\n\n---\n\n## Demo\n\n<table>\n  <tr>\n    <td width=\"50%\" align=\"center\">\n      🏠 <strong>Local tenant overview</strong><br/>\n    </td>\n    <td width=\"50%\" align=\"center\">\n      ☁️ <strong>Cloud tenant collections</strong><br/>\n    </td>\n  </tr>\n</table>\n\n---\n\n## Features\n\n|   | Capability | Description |\n|---|---|---|\n| 🔌 | **Universal Connect** | Local Chroma server, self-hosted API, or managed deployment — no config files needed |\n| 🧭 | **Tenant & Database Switcher** | Prefill tenant/database via CLI flags and swap with a single click |\n| 📂 | **Collection Explorer** | Inspect collection metadata, dimensions, and replication status instantly |\n| 📝 | **Record Actions** | Run add/upsert/delete/count/search operations with JSON payload helpers |\n| 🔍 | **Raw API Console** | Craft arbitrary REST calls against `/api/v2/*` with live responses |\n| 🔒 | **API Key Injection** | Pass `--api-key`/`--api-key-header` to pre-seed secure cloud sessions |\n| ⚡ | **Zero Install** | Runs through `npx` — no global install, no dependencies, no setup files |\n\n---\n\n## Quick Start\n\n**Step 1 — Start Chroma** *(skip if already running)*\n\nThe official Docker image exposes Chroma on container port `8000`. The workbench defaults to `http://localhost:8000`, so map `8000:8000`:\n\n```bash\ndocker run --rm -p 8000:8000 ghcr.io/chroma-core/chroma:latest\n```\n\nIf you prefer a different host port (e.g. `6333`):\n\n```bash\ndocker run --rm -p 6333:8000 ghcr.io/chroma-core/chroma:latest\n```\n\nThen launch with `--url http://localhost:6333`.\n\n| Docker port mapping | Workbench endpoint | Heartbeat URL |\n| --- | --- | --- |\n| `-p 8000:8000` | `http://localhost:8000` | `http://localhost:8000/api/v2/heartbeat` |\n| `-p 6333:8000` | `http://localhost:6333` | `http://localhost:6333/api/v2/heartbeat` |\n\n**Step 2 — Launch the Workbench**\n\n```bash\nnpx chroma-db-workbench\n```\n\nYour browser opens automatically at a local URL, pre-connected to `http://localhost:8000`. Tenants, databases, and collections load instantly. ✅\n\n**Step 3 — Point it anywhere**\n\n```bash\nnpx chroma-db-workbench --url https://my-chroma.example --tenant playground --database analytics\n```\n\n---\n\n## Usage\n\n```text\nnpx chroma-db-workbench [options]\n\nOptions:\n  -u, --url <url>           Default Chroma endpoint shown in the UI\n                             (default: http://localhost:8000)\n      --tenant <name>       Prefill tenant (default: default_tenant)\n      --database <name>     Prefill database (default: default_database)\n      --api-key <token>     Prefill API key (switches defaults to cloud mode)\n      --api-key-header <h>  Prefill custom API key header (default: x-chroma-token)\n  -p, --port <port>         Port to serve the UI on (default: first free from 7070)\n      --host <host>         Host to bind to (default: 127.0.0.1)\n      --no-open             Do not open the browser automatically\n  -h, --help                Show this help\n  -v, --version             Show version\n```\n\n### Examples\n\n| Goal | Command |\n|---|---|\n| 🚀 **Default launch** | `npx chroma-db-workbench` |\n| 💻 **Local endpoint** | `npx chroma-db-workbench --url http://localhost:8000` |\n| ☁️ **Managed cluster** | `npx chroma-db-workbench --url https://my-chroma.example --tenant prod --database analytics` |\n| 🖥️ **Headless / remote** | `npx chroma-db-workbench --host 0.0.0.0 --no-open` |\n\n---\n\n## Connection Reference\n\n### 🖥️ Local Mode\n\nConnect to any Chroma deployment running on your machine or internal network. No authentication headers are added.\n\n| Field | Value | Notes |\n| --- | --- | --- |\n| Endpoint | `http://localhost:8000` | Use the host port from your Docker mapping. |\n| Tenant | `default_tenant` | Default tenant for a local Chroma server. |\n| Database | `default_database` | Default database for a local Chroma server. |\n| Token header | `x-chroma-token` | Safe to leave as-is. |\n| Token | Leave empty | Default local Docker server does not require a token. |\n\n> Works with Docker, local binaries, or a proxy such as `http://localhost:8787`.\n\n### ☁️ Cloud Mode\n\nEnter your managed Chroma REST endpoint, tenant, database, and API key in the connection panel. Authentication headers are injected automatically.\n\nCreate or select a database in Chroma Cloud, then copy the connection values from the dashboard or CLI:\n\n```bash\nchroma db connect <database-name> --env-vars\n```\n\n| Field | Value | Notes |\n| --- | --- | --- |\n| Connection type | `Cloud` | Select this before connecting. |\n| Endpoint | `CHROMA_DB_CLOUD_ENDPOINT` value | Copy from Chroma Cloud settings or CLI output. |\n| Tenant | `CHROMA_TENANT` value | Copy from dashboard, CLI output, or `.env`. |\n| Database | `CHROMA_DATABASE` value | Copy from dashboard, CLI output, or `.env`. |\n| Token header | `x-chroma-token` | Required header for Chroma Cloud API calls. |\n| Token | `CHROMA_API_KEY` value | Paste the API key value, not the variable name. |\n\nVerify the cloud token before opening the workbench:\n\n```bash\ncurl \"$CHROMA_DB_CLOUD_ENDPOINT/api/v2/auth/identity\" \\\n  --header \"x-chroma-token: $CHROMA_API_KEY\"\n```\n\n> **Tip:** Pass `--api-key` (and optionally `--api-key-header`) on the CLI so the UI opens already authenticated.\n\n### Verify Connection\n\nCheck your local server is responding before opening the workbench:\n\n```bash\ncurl http://localhost:8000/api/v2/heartbeat\n```\n\nIf you mapped a different host port, use that port in the URL:\n\n```bash\ncurl http://localhost:6333/api/v2/heartbeat\n```\n\n\n> **Privacy:** Nothing is proxied through third-party services — only your browser talks to Chroma.\n>\n> **CORS:** Ensure your Chroma deployment allows the workbench origin (`http://localhost:<port>`) in its CORS policy.\n\n---\n\n## Requirements\n\n- Node.js `>=18`\n- A running [Chroma DB](https://www.trychroma.com/) instance (local or cloud)\n- No additional dependencies or configuration files needed\n\n---\n\n\n## Support & Feedback\n\n| | |\n|---|---|\n| 🌐 **Project Page** | Coming soon |\n| 🐛 **Issues** | [Open an issue](https://github.com/harishkaparwan/chroma-db-workbench/issues) |\n| 🔒 **Privacy Policy** | Included in `ui/policy/`\n\n---\n\n<div align=\"center\">\n\n**Zero-config Chroma DB admin for builders and operators.**\n\n<br/>\n<sub>Built with ❤️ for the Chroma community</sub>\n\n</div>\n","readmeFilename":"README.md"}