LEANN
[MLsys2026]: RAG on Everything with LEANN. Enjoy 97% storage savings while running a fast, accurate, and 100% private RAG application on your personal device.
File Explorer
Download Latest Version (.zip)- devcontainer.json
- bug_report.yml
- config.yml
- feature_request.yml
- build-and-publish.yml
- build-reusable.yml
- link-check.yml
- release-manual.yml
- pull_request_template.md
- extensions.json
- settings.json
- __init__.py
- chatgpt_reader.py
- __init__.py
- __init__.py
- claude_reader.py
- email.py
- LEANN_email_reader.py
- __init__.py
- gemini_reader.py
- __init__.py
- history.py
- wechat_history.py
- __init__.py
- imessage_reader.py
- image.png
- colqwen_forward.py
- leann_multi_vector.py
- multi-vector-leann-paper-example.py
- multi-vector-leann-similarity-map.py
- README.md
- vidore_v1_benchmark.py
- vidore_v2_benchmark.py
- __init__.py
- qwen_reader.py
- leann-plus-temporal-search.py
- leann_index_builder.py
- spotlight_index_dump.py
- __init__.py
- slack_mcp_reader.py
- __init__.py
- twitter_mcp_reader.py
- __init__.py
- base_rag_example.py
- browser_rag.py
- chatgpt_rag.py
- claude_rag.py
- code_rag.py
- colqwen_rag.py
- document_rag.py
- email_rag.py
- gemini_rag.py
- image_rag.py
- imessage_rag.py
- qwen_rag.py
- slack_rag.py
- twitter_rag.py
- wechat_rag.py
- arch.png
- claude_code_leann.png
- effects.png
- logo-text.png
- logo.png
- mcp_leann.png
- wechat_user_group.JPG
- README.md
- run_bm25.py
- run_diskann.py
- trace_recorder.py
- auto_run.py
- batch_run_random.py
- batch_run_selected.py
- prepare_repos_with_leann.py
- .gitignore
- README.md
- README.md
- .gitignore
- evaluate_enron_emails.py
- README.md
- setup_enron_emails.py
- evaluate_financebench.py
- README.md
- setup_financebench.py
- verify_recall.py
- .gitignore
- evaluate_laion.py
- README.md
- setup_laion.py
- __init__.py
- bench_hnsw_rng_recompute.py
- bench_results.csv
- bench_update_vs_offline_search.py
- offline_vs_update.csv
- plot_bench_results.py
- README.md
- __init__.py
- benchmark_embeddings.py
- benchmark_no_recompute.py
- compare_faiss_vs_leann.py
- diskann_vs_hnsw_speed_comparison.py
- faiss_only.py
- flashlib_ivf_vs_faiss_ivf.py
- issue_159.py
- llm_utils.py
- micro_tpt.py
- README.md
- run_evaluation.py
- simple_mac_tpt_test.py
- 2501.14312v1 (1).pdf
- 2506.08276v1.pdf
- huawei_pangu.md
- PrideandPrejudice.txt
- Dockerfile
- Dockerfile.cpu
- Dockerfile.dev
- README.md
- embedding_model_compare.py
- smart-embedding-default.md
- slack_integration_1.1.png
- slack_integration_1.2.png
- slack_integration_1.3.png
- slack_integration_2.1.png
- slack_integration_2.2.png
- slack_integration_2.3.png
- ast_chunking_guide.md
- CHANGELOG.md
- COLQWEN_GUIDE.md
- configuration-guide.md
- CONTRIBUTING.md
- faq.md
- features.md
- flashlib_backend_guide.md
- grep_search.md
- metadata_filtering.md
- normalized_embeddings.md
- openclaw-setup.md
- react_agent.md
- RELEASE.md
- roadmap.md
- slack-setup-guide.md
- THINKING_BUDGET_FEATURE.md
- ultimate_goal.md
- user-scripts.md
- __init__.py
- basic_demo.py
- dynamic_update_no_recompute.py
- grep_search_example.py
- mcp_integration_demo.py
- mlx_demo.py
- spoiler_free_book_rag.py
- __init__.py
- pyproject.toml
- README.md
- __init__.py
- diskann_backend.py
- diskann_embedding_server.py
- embedding_pb2.py
- graph_partition.py
- DiskANN
- embedding.pb.cc
- embedding.proto
- __init__.py
- CMakeLists.txt
- pyproject.toml
- __init__.py
- flashlib_backend.py
- pyproject.toml
- README.md
- __init__.py
- flashlib_ivf_backend.py
- pyproject.toml
- README.md
- __init__.py
- convert_to_csr.py
- hnsw_backend.py
- hnsw_embedding_server.py
- cppzmq
- faiss
- libzmq
- msgpack-c
- CMakeLists.txt
- pyproject.toml
- __init__.py
- ivf_backend.py
- pyproject.toml
- README.md
- __init__.py
- __main__.py
- api.py
- chat.py
- chunking_utils.py
- cli.py
- embedding_compute.py
- embedding_server_manager.py
- interactive_utils.py
- interface.py
- mcp.py
- metadata_filter.py
- react_agent.py
- registry.py
- searcher_base.py
- server.py
- settings.py
- sync.py
- web_search.py
- pyproject.toml
- README.md
- README.md
- __init__.py
- main.py
- wechattweak-cli
- __init__.py
- astchunk-leann
- build_and_test.sh
- bump_version.sh
- hf_upload.py
- release.sh
- upload_to_pypi.sh
- claw.json
- instructions.md
- README.md
- leann-build.yaml
- 2026-02-15.md
- 2026-02-20.md
- 2026-02-25.md
- MEMORY.md
- .gitignore
- __init__.py
- conftest.py
- docker-compose.yml
- run_docker_test.sh
- test_build_and_search.py
- test_mcp_e2e.py
- test_mcp_protocol.py
- test_openclaw_e2e.py
- test_skill_manifest.py
- fake_embedding_server_module.py
- README.md
- test_astchunk_integration.py
- test_atlascloud_provider.py
- test_basic.py
- test_build_from_arrays.py
- test_ci_minimal.py
- test_cli_ask.py
- test_cli_daemon_workflow.py
- test_cli_list_performance.py
- test_cli_prompt_template.py
- test_cli_verbosity.py
- test_cpu_only_install.py
- test_diskann_partition.py
- test_document_rag.py
- test_embedding_batch_size.py
- test_embedding_prompt_template.py
- test_embedding_server_cli_flags.py
- test_embedding_server_manager.py
- test_embedding_server_manager_e2e.py
- test_flashlib_ivf_backend.py
- test_hnsw_rebuild_fallback.py
- test_hybrid_search.py
- test_incremental_build.py
- test_litellm_provider.py
- test_lmstudio_bridge.py
- test_mcp_integration.py
- test_mcp_standalone.py
- test_metadata_filtering.py
- test_minimax_provider.py
- test_novita_provider.py
- test_passage_id_scheme.py
- test_prompt_template_e2e.py
- test_prompt_template_persistence.py
- test_react_dual_source.py
- test_readme_examples.py
- test_rebuild_cli.py
- test_sync.py
- test_token_truncation.py
- test_watch_sync_scope.py
- google_clear.gif
- mail_clear.gif
- paper_clear.gif
- wechat_clear.gif
- .gitignore
- .gitmodules
- .pre-commit-config.yaml
- .python-version
- CLAUDE.md
- demo.ipynb
- LICENSE
- llms.txt
- pyproject.toml
- README.md
- uv.lock
๐ Installation Guide
1. Get the code
git clone https://github.com/StarTrail-org/LEANN
Downloads the entire project code from GitHub to your computer.
cd LEANN
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Homebrew A package manager for macOS/Linux.
- Chocolatey A package manager for Windows.
curl -LsSf https://astral.sh/uv/install.sh | sh
Downloads and runs the official install script in one line โ this handles the full setup automatically.
brew install libomp boost protobuf zeromq pkgconf
Installs the pre-built package via Homebrew โ no source build required.
choco install cmake swig pkgconfiglite nuget.commandline -y
Installs directly via Chocolatey (Windows).
curl -fsSL https://ollama.ai/install.sh | sh
Downloads and runs the official install script in one line โ this handles the full setup automatically.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f docker/Dockerfile -t leann .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 leann
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
4. CMake
MediumPrerequisites
sudo pacman -Syu && sudo pacman -S --needed base-devel cmake pkgconf git gcc \
Type this command into your terminal and run it.
choco install cmake swig pkgconfiglite nuget.commandline -y
Installs directly via Chocolatey (Windows).
Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).
Pulled directly from this repo's README.
5. Python
EasyPrerequisites
uv pip install leann
Installs the Python libraries listed in requirements.txt (or similar).
python -m apps.document_rag --query "What are the main techniques LEANN explores?"
Runs the Python script (or module).
python -m apps.document_rag --data-dir "~/Documents/Papers" --chunk-size 1024
Runs the Python script (or module).
python -m apps.document_rag --data-dir "./docs" --chunk-size 256 --file-types .md .py
Runs the Python script (or module).
python -m apps.document_rag --enable-code-chunking --data-dir "./my_project"
Runs the Python script (or module).
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)