Getting Started

What is Kimi CLI

Kimi CLI is an AI agent that runs in the terminal, helping you complete software development tasks and terminal operations. It can read and edit code, execute shell commands, search and fetch web pages, and autonomously plan and adjust actions during execution.

Kimi CLI is suited for:

• Writing and modifying code: Implementing new features, fixing bugs, refactoring code
• Understanding projects: Exploring unfamiliar codebases, answering architecture and implementation questions
• Automating tasks: Batch processing files, running builds and tests, executing scripts

Kimi CLI provides a shell-like interactive experience in the terminal. You can describe your needs in natural language or switch to shell mode at any time to execute commands directly. Beyond terminal usage, Kimi CLI also supports integration with IDEs and other local agent clients via the Agent Client Protocol.

Note

Kimi CLI is currently in technical preview. Features and APIs may change. If you encounter issues or have suggestions, please provide feedback on GitHub Issues.

Installation

Run the installation script to complete the installation. The script will first install uv (a Python package manager), then install Kimi CLI via uv:

# Linux / macOS
curl -LsSf https://cdn.kimi.com/binaries/kimi-cli/install.sh | bash

# Windows (PowerShell)
Invoke-RestMethod https://cdn.kimi.com/binaries/kimi-cli/install.ps1 | Invoke-Expression

Verify the installation:

kimi --version

TIP

Due to macOS security checks, the first run of the kimi command may take longer. You can add your terminal application in "System Settings → Privacy & Security → Developer Tools" to speed up subsequent launches.

If you already have uv installed, you can also run:

uv tool install --python 3.14 kimi-cli

Upgrade and uninstall

Upgrade to the latest version:

uv tool upgrade kimi-cli --no-cache

Uninstall Kimi CLI:

uv tool uninstall kimi-cli

First run

Run the kimi command in the project directory where you want to work to start Kimi CLI:

cd your-project
kimi

On first launch, you need to configure the API platform and model. Enter the /setup command to start the configuration wizard:

1. Select an API platform (e.g., Kimi Code, Moonshot AI Open Platform)
2. Enter your API key
3. Select the model to use

After configuration, Kimi CLI will automatically save the settings and reload. See Providers for details.

Now you can chat with Kimi CLI directly using natural language. Try describing a task you want to complete, for example:

Show me the directory structure of this project

TIP

If the project doesn't have an AGENTS.md file, you can run the /init command to have Kimi CLI analyze the project and generate this file, helping the AI better understand the project structure and conventions.

Enter /help to view all available slash commands and usage tips.