From d0f8e24e9b4d2c6dd68d93bc804a4390bf661c10 Mon Sep 17 00:00:00 2001 From: 7Sageer <12210216@mail.sustech.edu.cn> Date: Thu, 4 Jun 2026 17:04:02 +0800 Subject: [PATCH] docs: mention Windows Git Bash requirement (#419) * docs: mention Windows Git Bash requirement * docs: add Windows Git Bash changeset --- .changeset/windows-git-bash-docs.md | 5 +++++ README.md | 2 ++ README.zh-CN.md | 2 ++ apps/kimi-code/README.md | 2 ++ docs/en/guides/getting-started.md | 2 ++ docs/zh/guides/getting-started.md | 2 ++ 6 files changed, 15 insertions(+) create mode 100644 .changeset/windows-git-bash-docs.md diff --git a/.changeset/windows-git-bash-docs.md b/.changeset/windows-git-bash-docs.md new file mode 100644 index 000000000..8d7e00d7e --- /dev/null +++ b/.changeset/windows-git-bash-docs.md @@ -0,0 +1,5 @@ +--- +"@moonshot-ai/kimi-code": patch +--- + +Document the Git Bash prerequisite for Windows installs. diff --git a/README.md b/README.md index 501bf8199..7902de131 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ curl -fsSL https://code.kimi.com/kimi-code/install.sh | bash irm https://code.kimi.com/kimi-code/install.ps1 | iex ``` +> On Windows, install [Git for Windows](https://gitforwindows.org/) before first launch because Kimi Code CLI uses the bundled Git Bash as its shell environment. If Git Bash is installed in a custom location, set `KIMI_SHELL_PATH` to the absolute path of `bash.exe`. + Then, run it with a new shell session: ```sh diff --git a/README.zh-CN.md b/README.zh-CN.md index 8e9146cb0..5a8714b05 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -28,6 +28,8 @@ curl -fsSL https://code.kimi.com/kimi-code/install.sh | bash irm https://code.kimi.com/kimi-code/install.ps1 | iex ``` +> Windows 用户首次启动前还需要安装 [Git for Windows](https://gitforwindows.org/),Kimi Code CLI 会使用其中的 Git Bash 作为 Shell 环境。如果 Git Bash 安装在非标准路径,请把 `KIMI_SHELL_PATH` 设为 `bash.exe` 的绝对路径。 + 随后在新的终端会话中运行: ```sh diff --git a/apps/kimi-code/README.md b/apps/kimi-code/README.md index 79cd3ad91..7c92bc3a5 100644 --- a/apps/kimi-code/README.md +++ b/apps/kimi-code/README.md @@ -24,6 +24,8 @@ curl -fsSL https://code.kimi.com/kimi-code/install.sh | bash irm https://code.kimi.com/kimi-code/install.ps1 | iex ``` +> On Windows, install [Git for Windows](https://gitforwindows.org/) before first launch because Kimi Code CLI uses the bundled Git Bash as its shell environment. If Git Bash is installed in a custom location, set `KIMI_SHELL_PATH` to the absolute path of `bash.exe`. + Then run it with a new Terminal session: ```sh diff --git a/docs/en/guides/getting-started.md b/docs/en/guides/getting-started.md index 13a813071..fc19eee27 100644 --- a/docs/en/guides/getting-started.md +++ b/docs/en/guides/getting-started.md @@ -30,6 +30,8 @@ curl -fsSL https://code.kimi.com/kimi-code/install.sh | bash irm https://code.kimi.com/kimi-code/install.ps1 | iex ``` +> On Windows, install [Git for Windows](https://gitforwindows.org/) before first launch. Kimi Code CLI uses the bundled Git Bash as its shell environment; if Git Bash is installed in a custom location, set `KIMI_SHELL_PATH` to the absolute path of `bash.exe`. + The script automatically downloads the latest release, verifies the checksum, and places the `kimi` executable on your `PATH`. ### npm installation diff --git a/docs/zh/guides/getting-started.md b/docs/zh/guides/getting-started.md index 1865ca2e7..3324543f5 100644 --- a/docs/zh/guides/getting-started.md +++ b/docs/zh/guides/getting-started.md @@ -30,6 +30,8 @@ curl -fsSL https://code.kimi.com/kimi-code/install.sh | bash irm https://code.kimi.com/kimi-code/install.ps1 | iex ``` +> Windows 用户首次启动前还需要安装 [Git for Windows](https://gitforwindows.org/),Kimi Code CLI 会使用其中的 Git Bash 作为 Shell 环境。如果 Git Bash 安装在非标准路径,请把 `KIMI_SHELL_PATH` 设为 `bash.exe` 的绝对路径。 + 脚本会自动下载最新版本、校验 checksum,并把 `kimi` 可执行文件放到你的 `PATH` 中。 ### npm 安装