TBNilles/LEANN
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Clarify CLI global installation process

Browse Source 
- 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
This commit is contained in:
Andy Lee
2025-07-29 14:06:16 -07:00
parent ff389c7d8d
commit cc0c091ca5
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -400,19 +400,22 @@ LEANN includes a powerful CLI for document processing and search. Perfect for qu
### Installation ### 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 ```bash
source .venv/bin/activate source .venv/bin/activate
leann --help leann --help
``` ```
**Option 2: Install globally with uv tool (recommended for daily use)** **To make it globally available (recommended for daily use):**
```bash ```bash
# Install the LEANN CLI globally # Install the LEANN CLI globally using uv tool
uv tool install leann uv tool install leann
# Now you can use leann from anywhere # Now you can use leann from anywhere without activating venv
leann --help leann --help
# To update the global installation later
uv tool upgrade leann
``` ```
### Usage Examples ### Usage Examples