From cc0c091ca5457ce48abe7778f4bed61edce97669 Mon Sep 17 00:00:00 2001 From: Andy Lee Date: Tue, 29 Jul 2025 14:06:16 -0700 Subject: [PATCH] docs: Clarify CLI global installation process - Explain the transition from venv to global installation - Add upgrade command for global installation - Make it clear that global install allows usage without venv activation --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4a749b9..df3f0f7 100755 --- a/README.md +++ b/README.md @@ -400,19 +400,22 @@ LEANN includes a powerful CLI for document processing and search. Perfect for qu ### Installation -**Option 1: Use from virtual environment (already installed if you followed Quick Start)** +If you followed the Quick Start, `leann` is already installed in your virtual environment: ```bash source .venv/bin/activate leann --help ``` -**Option 2: Install globally with uv tool (recommended for daily use)** +**To make it globally available (recommended for daily use):** ```bash -# Install the LEANN CLI globally +# Install the LEANN CLI globally using uv tool uv tool install leann -# Now you can use leann from anywhere +# Now you can use leann from anywhere without activating venv leann --help + +# To update the global installation later +uv tool upgrade leann ``` ### Usage Examples