Getting started
This page covers getting started and basic operations. For more features and the latest changes, see the complete guide maintained by the Kimi Code team.
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.
Install script (recommended)
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_PATHto the absolute path ofbash.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:
First launch
Move into your project directory and run kimi to start the interactive UI:
To run a single instruction without entering the interactive UI, use -p:
To resume the previous session, add -c:
On first launch you need to configure an API source. In the interactive UI, enter /login to begin the login flow:
/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.comorplatform.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:
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:
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
| Command | Description |
|---|---|
/new | Start a new session, clearing the current context |
/sessions | Browse session history and choose one to resume |
/model | Switch the current model |
/compact | Manually compress the context to free up tokens |
/fork | Fork the current session into an independent copy with full history (you stay in the current session) |
Most-used keyboard shortcuts
| Shortcut | Description |
|---|---|
Esc | Interrupt streaming output / close a popup |
Ctrl-C | Interrupt output; press twice while idle to exit |
Shift-Tab | Toggle Plan mode |
Ctrl-S | Inject a message mid-stream without waiting for the current response to finish |
Ctrl-O | Collapse / expand tool output and compaction summaries |
For the full list, type /help or visit Slash commands reference and Keyboard shortcuts.
More operations
Interaction and basic operations. For upgrades, uninstalling, data locations, and troubleshooting, see the maintained guide.
Was this article helpful?