Skip to main content

A TUI for ChromaDB

Project description

Chroma TUI

A terminal user interface (TUI) for browsing and managing ChromaDB instances.

Features

  • Browse collections and view document counts
  • View complete documents with metadata and embeddings
  • Create and delete collections
  • Add documents to collections
  • Search documents using semantic similarity
  • Interactive and intuitive interface

Installation

From PyPI

pip install chroma-tui

From Source

  1. Clone this repository:

    git clone https://github.com/Mukhunyeledzi-Muthuphei/chromadb-tui.git
    cd chromadb-tui
    
  2. Install the package:

    pip install -e .
    

Usage

Run the TUI from your terminal:

chroma-tui

You'll be prompted to enter your ChromaDB server connection details (host and port). Once connected, you can:

  • View Collections: Browse all collections and their document counts
  • Create Collection: Add new collections to your database
  • Delete Collection: Remove collections from your database
  • View Document: Display complete document details including text, metadata, and optional embedding vectors
  • Search Documents: Perform semantic similarity searches across documents
  • Add Document: Insert new documents into collections

Requirements

  • Python 3.8+
  • ChromaDB server instance (running separately)

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chroma_tui-0.1.1.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chroma_tui-0.1.1-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file chroma_tui-0.1.1.tar.gz.

File metadata

  • Download URL: chroma_tui-0.1.1.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for chroma_tui-0.1.1.tar.gz
Algorithm Hash digest
SHA256 29a6f9f9b34797bab7c9ff04b8c477dbd9706e2d017d1febc27d897b782b6bd9
MD5 b0cb48327cab8fa995f28efffea29d67
BLAKE2b-256 1dd4984b53c5b50d99762a87eee5c74436f0992132e410a18e9595a0a1b75c30

See more details on using hashes here.

File details

Details for the file chroma_tui-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: chroma_tui-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for chroma_tui-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1068005e2d5eda2be9edae943bdec530680892f3b30e6f4b11cf798d7624bd02
MD5 d4ecaf06ec9175758f29d1a286e9457c
BLAKE2b-256 6bccbae8660dced090a55e9739270db8bf75c2ce01e58cbe3710f7c756e86154

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page