docs(readme): add prerequisites list to Development section#2287
Conversation
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 MoonshotAI#2274.
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7d90c03d48
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - **uv** ≥ 0.8 — package + venv manager. Install: <https://docs.astral.sh/uv/getting-started/installation/> (`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). |
There was a problem hiding this comment.
This prerequisite says Node.js/npm is only needed for make build-web or make build, but contributors following the same README are also told to run make format and make check, and both targets invoke npm via format-web and check-web in Makefile. In environments without Node.js, those common validation steps fail (npm not found), so this wording can mislead new contributors into an avoidable setup failure.
Useful? React with 👍 / 👎.
2 participants
Resolves #2274.
Change
Adds a
### Prerequisitessubsection at the top of the README's## Developmentsection listing what a contributor needs installed beforemake preparewill work.Why
Today the README jumps straight from the user-install instructions into
make preparewith no statement of what the contributor needs first. New contributors hit one of:make: command not found(Windows users without WSL or build tools)uv: command not found(no link to install instructions in this section)make build-webfailing because Node.js / npm aren't installedsrc/kimi_cli/utils/environment.py'sGitBashNotFoundError— easy to hit while testing your changes)pip installsomething or rely on uv to manage the venvWhat's listed
pyproject.toml'suv_build>=0.8.5,<0.10.0).python-version)make build-web/make buildGitBashNotFoundErrorflake.nixas an all-in-one shortcutAll version pins verified against the actual repo files (
.python-version,pyproject.toml,flake.nix,src/kimi_cli/utils/environment.py).Diff
Pure docs change. No code touched.
🤖 Generated with Claude Code