From ff389c7d8d8d1b9b86d82ff8afb7272a626154f2 Mon Sep 17 00:00:00 2001 From: Andy Lee Date: Tue, 29 Jul 2025 14:05:33 -0700 Subject: [PATCH] docs: Add CLI installation instructions - Add two installation options: venv and global uv tool - Clearly explain when to use each option - Make CLI more accessible for daily use --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 3584bf6..4a749b9 100755 --- a/README.md +++ b/README.md @@ -398,6 +398,25 @@ Once the index is built, you can ask questions like: LEANN includes a powerful CLI for document processing and search. Perfect for quick document indexing and interactive chat. +### Installation + +**Option 1: Use from virtual environment (already installed if you followed Quick Start)** +```bash +source .venv/bin/activate +leann --help +``` + +**Option 2: Install globally with uv tool (recommended for daily use)** +```bash +# Install the LEANN CLI globally +uv tool install leann + +# Now you can use leann from anywhere +leann --help +``` + +### Usage Examples + ```bash # Build an index from documents leann build my-docs --docs ./documents