update readme

This commit is contained in:
Matteo Rosati
2026-04-22 10:23:08 +02:00
parent e80a037858
commit e3e0214e1c
+54 -8
View File
@@ -17,7 +17,7 @@ A small command-line utility for working with a local Chroma database. It lets y
## Installation ## Installation
Using `uv`: For local development, install the project dependencies with `uv`:
```bash ```bash
uv sync uv sync
@@ -31,9 +31,55 @@ source .venv/bin/activate
pip install -e . pip install -e .
``` ```
## Build
Build the source distribution and wheel with `uv`:
```bash
uv build
```
The build artifacts are written to `dist/`.
## Install as a tool with uv
The project exposes a `chromy` command through the Python packaging entrypoint.
Install it as a standalone `uv` tool from the project directory:
```bash
uv tool install .
```
After installation, run the CLI directly:
```bash
chromy --help
```
To install from a built wheel instead:
```bash
uv build
uv tool install dist/chromy-1.0.0-py3-none-any.whl
```
During development, install the tool in editable mode so changes in the working
tree are picked up without reinstalling:
```bash
uv tool install --editable .
```
## Running the CLI ## Running the CLI
The project entrypoint is `main.py`. The project entrypoint is available as the `chromy` command after installing the
tool:
```bash
chromy --help
```
You can also run it from the source tree without installing the tool:
```bash ```bash
uv run python main.py --help uv run python main.py --help
@@ -55,37 +101,37 @@ query | q <collection> <query_text>
Create a collection: Create a collection:
```bash ```bash
uv run python main.py create-collection notes chromy create-collection notes
``` ```
Add a file: Add a file:
```bash ```bash
uv run python main.py add-data notes ./docs/example.txt chromy add-data notes ./docs/example.txt
``` ```
Count stored records: Count stored records:
```bash ```bash
uv run python main.py count notes chromy count notes
``` ```
Search the collection: Search the collection:
```bash ```bash
uv run python main.py query notes "How do I configure this project?" chromy query notes "How do I configure this project?"
``` ```
List collections: List collections:
```bash ```bash
uv run python main.py list-collections chromy list-collections
``` ```
Delete a collection: Delete a collection:
```bash ```bash
uv run python main.py delete-collection notes chromy delete-collection notes
``` ```
## How ingestion works ## How ingestion works