Skip to content

docs(readme): add prerequisites list to Development section #2287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ktwu01 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(readme): add prerequisites list to Development section #2287

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: <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).
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Clarify Node.js is required for more than build targets

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 👍 / 👎.

- **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 <https://git-scm.com/download/win>.
- **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
Expand Down
Loading