Skip to content

SetUp.md

Latest commit

 

History

History
73 lines (49 loc) · 1.38 KB

SetUp.md

File metadata and controls

73 lines (49 loc) · 1.38 KB
Raw

Setting up CodeKnow for development

Prerequisites

  • Python 3.10+ (up to 3.13)
  • uv — package and project manager

Verify both are available:

python --version   # 3.10 or higher
uv --version

From source (development)

git clone <repo-url> CodeKnow
cd CodeKnow
uv sync

Run commands via uv run:

uv run codeknow --help
uv run codeknow-api --help

Development

uv run pytest                        # run tests
uv run project-scripts.py dev-check  # ruff + pyrefly
uv run project-scripts.py pipeline   # run the pipeline on a repo

Infrastructure

Running the pipeline and the e2e suite needs three backing services up: ChromaDB, Redis, and Docker Model Runner (embeddings). Bring them up with:

docker compose -f infra/docker-compose.yml up -d

See infra-setup.md for details, the embedding-model setup script, and troubleshooting.

Troubleshooting

uv: command not found

Install uv:

curl -LsSf https://astral.sh/uv/install.sh | sh

Restart your shell, then verify with uv --version.

python not found or wrong version

On macOS:

brew install python@3.12

uv will automatically detect the right Python version from pyproject.toml. You can also set it explicitly:

uv python install 3.12
uv python pin 3.12