kimi-code README

The project's README from github.com/MoonshotAI/kimi-code. As one markdown file: README.md.

Kimi Code CLI

License Docs
Documentation · Issues · 中文

Demo of using Kimi Code

What is Kimi Code CLI

Kimi Code CLI is an AI coding agent that runs in your terminal — it can read and edit code, run shell commands, search files, fetch web pages, and choose the next step based on the feedback it receives. It works out of the box with Moonshot AI’s Kimi models and can also be configured to use other compatible providers.

Install

Install with the official script. No Node.js required.

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 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:

kimi --version

For npm install, upgrade, uninstall, see Getting Started.

Quick Start

Open a project and start the interactive UI:

cd your-project
kimi

On first launch, run /login inside Kimi Code CLI and choose either Kimi Code OAuth or a Moonshot AI Open Platform API key. After login, try your first task:

Take a look at this project and explain its main directories.

Key Features

Use it in your editor (ACP)

Kimi Code CLI speaks the Agent Client Protocol, so ACP-compatible editors and IDEs (Zed, JetBrains, …) can drive a session over stdio. Log in once, then point your editor at the kimi acp subcommand — no extra login needed.

For Zed, add this to ~/.config/zed/settings.json:

{
  "agent_servers": {
    "Kimi Code CLI": {
      "type": "custom",
      "command": "kimi",
      "args": ["acp"],
      "env": {}
    }
  }
}

Then open a new conversation in Zed's Agent panel. See Using in IDEs for JetBrains setup and troubleshooting, and the kimi acp reference for the full capability matrix.

Docs

Develop

Requirements: Node.js ≥ 24.15.0, pnpm 10.33.0.

git clone https://github.com/MoonshotAI/kimi-code.git
cd kimi-code
pnpm install
pnpm dev:cli    # run the CLI in dev mode
pnpm test       # run tests
pnpm typecheck  # TypeScript check
pnpm lint       # oxlint
pnpm build      # build all packages

See CONTRIBUTING.md for the full contribution guide.

Community

Acknowledgements

Our TUI is built on top of pi-tui. We thank the authors of pi-tui for their valuable work.

License

Released under the MIT License.

kimi-code (MoonshotAI/kimi-code)

Searching Database…

What is this?Kimi Code CLI is an AI coding agent that runs in your terminal — it reads and edits code, runs shell commands, searches files, fetches web pages, and decides the next step based on the feedback it gets. It works with Moonshot AI's Kimi models out of the box and can be configured to use other compatible providers.
Is this a library I import, or a standalone app?It is a standalone terminal application distributed as a single binary, not a library you import into code. It also exposes an 'acp' subcommand so editors like Zed and JetBrains can drive a session over the Agent Client Protocol.
How do I get it running?Run the official install script (macOS/Linux shell command, or PowerShell on Windows) — no Node.js needed. Then open a project, run 'kimi' for the interactive TUI, and use '/login' to authenticate with either Kimi Code OAuth or a Moonshot AI Open Platform API key.
Do I need Node.js or Git installed first?No Node.js is required to install or run the CLI since it ships as a single binary. On Windows specifically you must install Git for Windows before first launch, since the CLI uses the bundled Git Bash as its shell environment.
Any install gotchas on Windows?If Git Bash is installed somewhere non-standard, you need to manually set the KIMISHELLPATH environment variable to the absolute path of bash.exe, or the CLI won't find a working shell.
Does it work the same on macOS, Linux, and Windows?Yes, the install script and CLI support macOS, Linux, and Windows, though Windows needs Git for Windows installed first for its Git Bash shell environment.
What happens if I drop a video into the chat?The agent can watch screen recordings or demo clips you drop in and act on them — for example turning a reference clip into a LUT, a long video into a short, or a screen recording into working code.
How do subagents work?Kimi Code CLI can dispatch built-in coder, explore, and plan subagents in isolated contexts to do focused, parallel work while keeping the main conversation clean.
Can I add MCP servers without hand-editing JSON?Yes, the '/mcp-config' command lets you add, edit, and authenticate Model Context Protocol servers conversationally instead of editing config files by hand.
Can plugins be installed from any GitHub repo?Yes, skills, MCP servers, and data sources can be installed from the official marketplace or any GitHub repo, with each install's trust level shown up front before you add it.
Creator
MoonshotAI
Size
123.4 MB
Stars
7.9K
Age
4mo
Commits · 90 Days