> ## Documentation Index
> Fetch the complete documentation index at: https://platform.kimi.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Use Kimi CLI to Call Kimi Model
## **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**](https://sw.kovidgoyal.net/kitty/) or [**Ghostty**](https://ghostty.org/).
### **Install script (recommended)**
* **macOS / Linux**:
```text theme={null}
curl -fsSL https://code.kimi.com/kimi-code/install.sh | bash
```
* **Windows (PowerShell)**:
```text theme={null}
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**
Requires Node.js 24.15.0 or later:
```text theme={null}
node --version
npm install -g @moonshot-ai/kimi-code
```
Or with pnpm:
```text theme={null}
pnpm add -g @moonshot-ai/kimi-code
```
## **Upgrade and uninstall**
After installation, verify that the executable is ready:
```text theme={null}
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:
```text theme={null}
npm install -g @moonshot-ai/kimi-code@latest
```
**Uninstall**: if you installed via the script, delete the `kimi` executable. If you installed via npm:
```text theme={null}
npm uninstall -g @moonshot-ai/kimi-code
```
## **First launch**
Move into your project directory and run `kimi` to start the interactive UI:
```text theme={null}
cd your-project
kimi
```
To run a single instruction without entering the interactive UI, use `-p`:
```text theme={null}
kimi -p "Take a look at this project's directory structure"
```
To resume the previous session, add `-C`:
```text theme={null}
kimi -C
```
On first launch you need to configure an API source. In the interactive UI, enter `/login` to begin the login flow:
```text theme={null}
/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**](https://www.kimi.com/code/docs/kimi-code-cli/configuration/providers.html) for details. For the full reference of all config options, see [**Configuration files**](https://www.kimi.com/code/docs/kimi-code-cli/configuration/config-files.html), [**Environment variables**](https://www.kimi.com/code/docs/kimi-code-cli/configuration/env-vars.html), and [**Configuration overrides**](https://www.kimi.com/code/docs/kimi-code-cli/configuration/overrides.html).
## **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:
```text theme={null}
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:
```text theme={null}
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**
| **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, keeping history but continuing independently |
**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 |
For the full list, type `/help` or visit [**Slash commands reference**](https://www.kimi.com/code/docs/kimi-code-cli/reference/slash-commands.html) and [**Keyboard shortcuts**](https://www.kimi.com/code/docs/kimi-code-cli/reference/keyboard.html).
## **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**](https://www.kimi.com/code/docs/kimi-code-cli/configuration/data-locations.html) and [**Environment variables**](https://www.kimi.com/code/docs/kimi-code-cli/configuration/env-vars.html).
## **Next steps**
* [**Interaction and input**](https://www.kimi.com/code/docs/kimi-code-cli/guides/interaction.html) — input box operations, approval flow, Plan mode, and YOLO mode explained
* [**Sessions and context**](https://www.kimi.com/code/docs/kimi-code-cli/guides/sessions.html) — resuming sessions, compressing context, exporting sessions
* [**Common use cases**](https://www.kimi.com/code/docs/kimi-code-cli/guides/use-cases.html) — prompt examples for typical tasks