Getting Started

How to get started with Leann

1

Install Leann

Run `uv pip install leann` or clone the repository and install dependencies using the provided commands.

2

Set LLM API Key

Set the environment variable for your LLM backend, for example: `export OPENAI_API_KEY="your-api-key-here"`.

3

Run CLI Queries

Use the CLI with flags like `--llm openai --llm-model <model-name>` for generation or `--embedding-mode openai --embedding-model <model>` for embeddings.

4

Test Example Queries

Try example queries such as searching Slack messages with phrases like "Find messages about the new feature launch".