From 7d90c03d484225cf1e7f1a74ce4133b43f7911a4 Mon Sep 17 00:00:00 2001 From: Koutian Wu Date: Thu, 14 May 2026 13:49:34 -0500 Subject: [PATCH] docs(readme): add prerequisites list to Development section Lists uv (>=0.8 per pyproject.toml's uv_build constraint), Python 3.14 (per .python-version), make, Node.js (only for make build-web / make build), Git Bash on Windows (required by the agent's Shell tool per src/kimi_cli/utils/environment.py), and Nix as an optional all-in-one shortcut via the existing flake.nix. Surfaces the 'I just cloned and ran make prepare and got make: command not found / uv: command not found / git-bash error' class of contributor friction. No code changes. Refs #2274. --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 544eac559..c2dbbb38d 100644 --- a/README.md +++ b/README.md @@ -143,7 +143,16 @@ See more features in the [Documentation](https://moonshotai.github.io/kimi-cli/e ## Development -To develop Kimi Code CLI, run: +### Prerequisites + +- **uv** ≥ 0.8 — package + venv manager. Install: (`pyproject.toml` requires `uv_build>=0.8.5,<0.10.0`). +- **Python 3.14** — pinned by `.python-version`; uv will install it for you on first `uv sync` if missing. (`pyproject.toml` accepts `>=3.12`, but 3.14 matches the lockfile / CI environment.) +- **make** — runs the build/test targets in `Makefile`. Most Linux/macOS already have it; Windows users need WSL or a `make` from MSYS2 / Chocolatey. +- **Node.js ≥ 20 + npm** — only required if you'll run `make build-web` or `make build` (the latter embeds the web UI). +- **Git Bash (Windows only)** — kimi-cli's agent requires `bash.exe` from Git for Windows; without it, the Shell tool will not start (see `src/kimi_cli/utils/environment.py`'s `GitBashNotFoundError`). Install via . +- **Nix (optional)** — a `flake.nix` is provided; `nix develop` drops you into a shell with all of the above. + +### Setup ```sh git clone https://github.com/MoonshotAI/kimi-cli.git