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…

7.9K ·GitHub
Kimi-code
Что это такое?Kimi Code CLI — это ИИ-агент для написания кода, который работает в терминале: он читает и редактирует код, выполняет команды оболочки, ищет файлы, загружает веб-страницы и сам решает, какой шаг сделать дальше, исходя из полученной обратной связи. Из коробки он работает с моделями Kimi от Moonshot AI, а также может быть настроен на другие совместимые провайдеры.
Это библиотека, которую нужно импортировать, или отдельное приложение?Это самостоятельное приложение для терминала, распространяемое как один исполняемый файл, а не библиотека, которую импортируют в код. Также есть подкоманда 'acp', благодаря которой такие редакторы, как Zed и JetBrains, могут управлять сеансом по протоколу Agent Client Protocol.
Как его запустить?Запустите официальный скрипт установки (команда для оболочки на macOS/Linux или PowerShell на Windows) — Node.js не нужен. Затем откройте проект, выполните 'kimi' для интерактивного TUI и используйте '/login', чтобы авторизоваться через Kimi Code OAuth или с ключом API из Moonshot AI Open Platform.
Нужно ли сначала установить Node.js или Git?Для установки и запуска CLI Node.js не нужен, так как он поставляется в виде одного исполняемого файла. Однако на Windows перед первым запуском обязательно нужно установить Git for Windows, поскольку CLI использует встроенную среду Git Bash в качестве оболочки.
Есть ли подводные камни при установке на Windows?Если Git Bash установлен в нестандартном месте, нужно вручную задать переменную окружения KIMISHELLPATH с абсолютным путём к bash.exe, иначе CLI не найдёт рабочую оболочку.
Одинаково ли он работает на macOS, Linux и Windows?Да, скрипт установки и CLI поддерживают macOS, Linux и Windows. Однако на Windows сначала нужно установить Git for Windows для его оболочки Git Bash.
Что будет, если загрузить видео в чат?Агент может посмотреть записи экрана или демонстрационные ролики, которые вы загрузите, и действовать по ним — например, превратить эталонный ролик в LUT, длинное видео в короткое или запись экрана в рабочий код.
Как работают субагенты?Kimi Code CLI может запускать встроенных субагентов coder, explore и plan в изолированных контекстах, чтобы они выполняли сфокусированную параллельную работу, не засоряя основной диалог.
Можно ли добавить MCP-серверы без ручного редактирования JSON?Да, команда '/mcp-config' позволяет добавлять, редактировать и авторизовывать серверы Model Context Protocol в диалоговом режиме, без ручного редактирования конфигурационных файлов.
Можно ли установить плагины из любого репозитория GitHub?Да, навыки, MCP-серверы и источники данных можно установить из официального маркетплейса или из любого репозитория GitHub; уровень доверия каждой установки показывается заранее, до её добавления.
What are similar projects?qwen-code, DeepSeek-Reasonix, Baize, oh-my-pi, grok-build, pi-shadow-mind, claurst, MiMo-Code
Which topics is it in?acp, marketplace, hooks, ai-coding, coding-agents, oauth, tui, model-context-protocol, video, agentic-ai, multi-agent, agents
Creator
MoonshotAI
Size
123.4 MB
Stars
7.9K
Updated
CommitOct 16Release@moonshot-ai/[email protected]Oct 14
Age
4mo
Commits · 90 Days