Skip to content

Getting started

What is Kimi Code CLI

Kimi Code CLI is an AI agent that runs in the terminal, helping you carry out software development tasks and day-to-day terminal operations — reading and modifying code, running shell commands, searching files, fetching web pages, and autonomously planning and adjusting its next steps based on feedback as it works.

It fits scenarios such as:

  • Writing and modifying code: implementing new features, fixing bugs, completing refactors
  • Understanding a project: exploring an unfamiliar codebase and answering questions about architecture and implementation
  • Automating tasks: batch-processing files, running builds and tests, chaining multiple scripts together

The CLI is written in TypeScript, distributed via npm, and runs on Node.js.

Installation

Two installation options are available: the official install script (recommended, no pre-installed Node.js required) and a global npm install.

Before you install

Kimi Code CLI is a fully interactive TUI application. For the best visual experience, run it in a terminal with true-color and ligature support, such as Kitty or Ghostty.

  • macOS / Linux:
sh
curl -fsSL https://code.kimi.com/kimi-code/install.sh | bash
  • Windows (PowerShell):
powershell
irm https://code.kimi.com/kimi-code/install.ps1 | iex

On Windows, install Git for Windows 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

Requires Node.js 22.19.0 or later:

sh
node --version
npm install -g @moonshot-ai/kimi-code

Or with pnpm:

sh
pnpm add -g @moonshot-ai/kimi-code

Upgrade and uninstall

After installation, verify that the executable is ready:

sh
kimi --version

Upgrade: run kimi upgrade — the CLI checks for the latest version and presents update options. Choose Install update now to upgrade based on your current install source. You can also upgrade directly via the package manager:

sh
npm install -g @moonshot-ai/kimi-code@latest

Uninstall: if you installed via the script, delete the kimi executable. If you installed via npm:

sh
npm uninstall -g @moonshot-ai/kimi-code

First launch

Move into your project directory and run kimi to start the interactive UI:

sh
cd your-project
kimi

To run a single instruction without entering the interactive UI, use -p:

sh
kimi -p "Take a look at this project's directory structure"

To resume the previous session, add -C:

sh
kimi -C

On first launch you need to configure an API source. In the interactive UI, enter /login to begin the login flow:

/login

/login opens a platform selector supporting two options:

  • Kimi Code (OAuth) — device-code flow; open the link on any device, sign in, and enter the code to authorize
  • Kimi Platform API key — enter an API key from platform.kimi.com or platform.kimi.ai

To sign out, enter /logout to clear the current credentials.

Using other AI providers

If you want to connect Anthropic, OpenAI, Google, or other providers, edit ~/.kimi-code/config.toml directly to configure the API key. See Providers and models for details. For the full reference of all config options, see Configuration files, Environment variables, and Configuration overrides.

Your first conversation

Once logged in, describe a task in natural language. A good starting point is to let Kimi Code CLI familiarize itself with the project:

Take a look at this project's directory structure and briefly describe what each directory is for.

Kimi Code CLI automatically calls file-reading, search, and other tools to browse the relevant content before responding. Read-only operations are executed automatically by default without requiring confirmation. For operations that modify files or run shell commands, it asks for your confirmation before proceeding.

You can also describe a more concrete task directly:

Add a function in src/utils that converts any string to kebab-case, and add a unit test for it.

Kimi Code CLI plans the steps, modifies the code, runs the tests, and tells you what it did at each step.

Not sure what to do? Type /help

Type /help at any time to open the built-in command and keyboard shortcut panel. Use / to browse and Esc to close. To exit, type /exit, press Ctrl-C twice, or press Ctrl-D with the input box empty.

Common commands and keyboard shortcuts

For a first-time user, the following is all you need to know:

Session commands

CommandDescription
/newStart a new session, clearing the current context
/sessionsBrowse session history and choose one to resume
/modelSwitch the current model
/compactManually compress the context to free up tokens
/forkFork the current session, keeping history but continuing independently

Most-used keyboard shortcuts

ShortcutDescription
EscInterrupt streaming output / close a popup
Ctrl-CInterrupt output; press twice while idle to exit
Shift-TabToggle Plan mode
Ctrl-SInject a message mid-stream without waiting for the current response to finish
Ctrl-OCollapse / expand tool output

For the full list, type /help or visit Slash commands reference and Keyboard shortcuts.

Where data is stored

Kimi Code CLI stores its local data under ~/.kimi-code/ by default — config files, session records, logs, and the update cache. To move it elsewhere, point to a new path via the KIMI_CODE_HOME environment variable. For the full directory layout, see Data locations and Environment variables.

Next steps