Files
Chromy/chromy/cli.py
T

173 lines
5.2 KiB
Python
Raw Normal View History

2026-04-22 22:14:26 +02:00
from __future__ import annotations
from typing import Annotated, Callable
import typer
2026-04-23 21:49:46 +02:00
from rich import print
2026-04-22 22:14:26 +02:00
from chromadb.errors import InternalError, NotFoundError
2026-04-23 19:34:59 +02:00
from chromy.handlers.import_data import handle_import
2026-04-22 22:14:26 +02:00
from chromy.handlers.count_collection import handle_count_collection
from chromy.handlers.create_collection import handle_create_collection
from chromy.handlers.delete_collection import (
handle_delete_collection,
handle_delete_records,
)
from chromy.handlers.list_collections import handle_list_collections
from chromy.handlers.query import handle_query
2026-04-22 22:27:55 +02:00
app = typer.Typer(help="Chromy, local RAG CLI based on Chromadb.")
2026-04-22 22:14:26 +02:00
ExitCodeHandler = Callable[[], int]
def _run(handler: ExitCodeHandler) -> None:
exit_code = handler()
if exit_code != 0:
raise typer.Exit(exit_code)
def _fail(message: str) -> None:
2026-04-23 21:49:46 +02:00
print("[bold red]Error[/]:", message)
2026-04-22 22:14:26 +02:00
raise typer.Exit(1)
2026-04-23 19:37:13 +02:00
# ------------------------------------------------------------------------------
# LIST COLLECTIONS
# ------------------------------------------------------------------------------
2026-04-22 22:14:26 +02:00
@app.command(
"list-collections",
help="List all collections stored in the local Chroma database.",
)
def list_collections() -> None:
_run(handle_list_collections)
2026-04-23 19:37:13 +02:00
# ------------------------------------------------------------------------------
# CREATE A COLLECTION
# ------------------------------------------------------------------------------
2026-04-22 22:14:26 +02:00
@app.command(
"create-collection",
help="Create a collection in the local Chroma database.",
)
def create_collection(
collection: Annotated[
str,
typer.Argument(help="Name of the collection to create."),
],
) -> None:
try:
_run(lambda: handle_create_collection(collection))
except InternalError:
_fail(f"Collection '{collection}' already exists.")
2026-04-23 19:37:13 +02:00
# ------------------------------------------------------------------------------
# DELETE A COLLECTION
# ------------------------------------------------------------------------------
2026-04-22 22:14:26 +02:00
@app.command(
"delete-collection",
help="Delete a collection from the local Chroma database.",
)
def delete_collection(
collection: Annotated[
str,
typer.Argument(help="Name of the collection to delete."),
],
) -> None:
try:
_run(lambda: handle_delete_collection(collection))
except NotFoundError:
_fail(f"Collection '{collection}' does not exist.")
2026-04-23 19:37:13 +02:00
# ------------------------------------------------------------------------------
# COUNT RECORDS
# ------------------------------------------------------------------------------
2026-04-22 22:14:26 +02:00
@app.command(
"count",
help="Count records in a collection from the local Chroma database.",
)
def count(
collection: Annotated[
str,
typer.Argument(help="Name of the collection to count."),
],
) -> None:
try:
_run(lambda: handle_count_collection(collection))
except NotFoundError:
_fail(f"Collection '{collection}' does not exist.")
2026-04-23 19:37:13 +02:00
# ------------------------------------------------------------------------------
# IMPORT DATA
# ------------------------------------------------------------------------------
2026-04-22 22:14:26 +02:00
@app.command(
2026-04-23 19:34:59 +02:00
"import",
2026-04-22 22:14:26 +02:00
help="Chunk, embed, and add a file to a collection in the local Chroma database.",
)
2026-04-23 19:34:59 +02:00
def import_data(
2026-04-22 22:14:26 +02:00
collection: Annotated[
str,
typer.Argument(help="Name of the target collection."),
],
file: Annotated[
str,
2026-04-23 21:06:31 +02:00
typer.Argument(
help="Path to the file to chunk and add to the collection."),
2026-04-22 22:14:26 +02:00
],
) -> None:
try:
2026-04-23 19:34:59 +02:00
_run(lambda: handle_import(collection, file))
2026-04-22 22:14:26 +02:00
except NotFoundError:
_fail(f"Collection '{collection}' does not exist.")
except FileNotFoundError:
_fail(f"The file {file} was not found.")
2026-04-23 19:37:13 +02:00
# ------------------------------------------------------------------------------
# QUERY
# ------------------------------------------------------------------------------
2026-04-22 22:14:26 +02:00
@app.command("query", help="Query a collection with the provided text.")
def query(
collection: Annotated[
str,
typer.Argument(help="Name of the target collection."),
],
query_text: Annotated[
str,
typer.Argument(help="The text to query."),
],
) -> None:
try:
_run(lambda: handle_query(collection, query_text))
except NotFoundError:
_fail(f"Collection '{collection}' does not exist.")
2026-04-23 19:37:13 +02:00
# ------------------------------------------------------------------------------
# DELETE DATA
# ------------------------------------------------------------------------------
2026-04-22 22:14:26 +02:00
@app.command("delete", help="Delete records from a collection using a metadata filter.")
def delete_records(
collection: Annotated[
str,
typer.Argument(help="Name of the target collection."),
],
where: Annotated[
str,
typer.Option(
"--where",
help="Metadata filter in the format <condition>=<value>.",
metavar="CONDITION=VALUE",
),
],
) -> None:
try:
_run(lambda: handle_delete_records(collection, where))
except NotFoundError:
_fail(f"Collection '{collection}' does not exist.")
except ValueError as exc:
_fail(str(exc))