overview getting started

Getting started

Use uv for local development and validation. The project ships no runtime dependencies by default, with optional Kuzu support behind the kuzu extra in pyproject.toml.

Prerequisites

• Python 3.11 or newer, with CI currently installing Python 3.13 in .github/workflows/ci.yml.
• uv for dependency and command execution.
• Docker only when running the daemon stack or embedding service from docker-compose.yml.

Install for development

uv sync --extra kuzu --dev

That command installs optional Kuzu support plus development tools declared in pyproject.toml.

Run the CLI

uv run lode index .
uv run lode search "knowledge graph" --json
uv run lode context "how does indexing work" --json --budget 4000
uv run lode impact index_repo --json

The command parser and handlers live in src/lode/cli.py. See CLI and daemon for the command map.

Run the daemon

uv run loded --host 127.0.0.1 --port 7979
curl http://127.0.0.1:7979/health

The daemon implementation lives in src/lode/daemon.py. Docker Compose in docker-compose.yml starts the daemon and a local embedding service.

Validate changes

Run the same checks as CI before committing:

uv run ruff format --check .
uv run ruff check .
uv run mypy src tests scripts benchmarks
uv run coverage run -m unittest discover -s tests -v
uv run coverage report
uv run radon cc src tests scripts -s -n B
uv run vulture src tests scripts --min-confidence 90
uv run deptry .
uv run bandit -c pyproject.toml -r src scripts -q
uv run python scripts/check_large_files.py
uv run python scripts/check_todos.py
uv run python scripts/check_agents_md.py
uv run python scripts/check_feature_flags.py
uv run python scripts/check_duplicate_code.py
uv run python scripts/generate_openapi_docs.py --check

Related pages

• Testing
• Tooling
• Configuration