Kimi Code

https://www.kimi.com/code/docs/
Admin
Kimi Code is a premium AI-powered coding platform that provides advanced development assistance...
Tokens:247,088
Snippets:1,850
Trust Score:9.3
Update:4 days ago
Show doc for...
Tokens:
Raw
### POST /api/v1/capabilities/{capability_id}:install

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/reference/server-api.html

Starts installing a capability in the background and returns immediately with the current status. Poll the GET endpoint for progress.

```APIDOC
## POST /api/v1/capabilities/{capability_id}:install

### Description
Starts installing a capability in the background and returns immediately with the current status. Poll the GET endpoint for progress.

### Method
POST

### Endpoint
/api/v1/capabilities/{capability_id}:install

### Parameters
#### Path Parameters
- **capability_id** (string) - Required - Capability id

### Response
#### Success Response (200)
- **data** (object) - Capability status object as documented under GET /api/v1/capabilities, with install.running set to true

#### Error Codes
- **40001**: missing or unknown action suffix
- **40418**: no capability with that id
- **40924**: an install of this capability is already running
- **40925**: the capability is not supported on this platform/architecture

#### Response Example
{
  "data": {
    "id": "kimi-cu",
    "displayName": "Kimi Computer Use",
    "description": "...",
    "supported": true,
    "state": "not_installed",
    "steps": [],
    "install": {
      "running": true,
      "percent": 0
    }
  }
}
```

--------------------------------

### Install Kimi Code CLI via script

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/guides/getting-started.html

Recommended installation method for macOS/Linux and Windows.

```sh
curl -fsSL https://code.kimi.com/kimi-code/install.sh | bash
```

```powershell
irm https://code.kimi.com/kimi-code/install.ps1 | iex
```

--------------------------------

### Install Windows Computer Use plugin

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/customization/plugins.html

Run this command in Kimi Code to install the Windows-specific version of the Computer Use plugin.

```bash
/plugins install https://cdn.kimi.com/kimi-computer-use-windows/latest/kimi-cu-win-plugin.zip
```

--------------------------------

### Start an autonomous goal

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/reference/slash-commands.html

Example of initiating a goal with specific instructions and constraints.

```sh
/goal Update the checkout docs, run docs build, and stop if still blocked after 20 turns
```

--------------------------------

### Complete configuration example in config.toml

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/configuration/config-files.html

A comprehensive example of the config.toml file covering common fields, provider settings, model definitions, and hook configurations.

```toml
default_model = "kimi-code/k3"
default_permission_mode = "manual"
default_plan_mode = false
merge_all_available_skills = true
telemetry = true

[providers."managed:kimi-code"]
type = "kimi"
base_url = "https://api.kimi.com/coding/v1"
api_key = ""

[models."kimi-code/k3"]
provider = "managed:kimi-code"
model = "k3"
max_context_size = 1048576
capabilities = [ "thinking", "always_thinking", "image_in", "video_in", "tool_use" ]
display_name = "K3"
support_efforts = [ "low", "high", "max" ]
default_effort = "max"

[models."kimi-code/kimi-for-coding"]
provider = "managed:kimi-code"
model = "kimi-for-coding"
max_context_size = 262144
capabilities = [ "thinking", "always_thinking", "image_in", "video_in", "tool_use" ]

[models."kimi-code/kimi-for-coding-highspeed"]
provider = "managed:kimi-code"
model = "kimi-for-coding-highspeed"
max_context_size = 262144
capabilities = [ "thinking", "always_thinking", "image_in", "video_in", "tool_use" ]

[thinking]
enabled = true
effort = "high"
keep = "all"

[loop_control]
max_attempts_per_step = 10
reserved_context_size = 50000

[background]
max_running_tasks = 4
keep_alive_on_exit = false

[services.moonshot_search]
base_url = "https://api.kimi.com/coding/v1/search"
api_key = ""

[services.moonshot_fetch]
base_url = "https://api.kimi.com/coding/v1/fetch"
api_key = ""

[[permission.rules]]
decision = "allow"
pattern = "Read"

[[permission.rules]]
decision = "deny"
pattern = "Bash(rm -rf*)"

[[hooks]]
event = "PreToolUse"
matcher = "Bash"
command = "node ~/.kimi-code/hooks/check-bash.mjs"
timeout = 5
```

--------------------------------

### Skill file structure example

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/customization/skills.html

An example showing the directory form and flat form file structures for organizing skills.

```text
skills/
├── review-pr/              # Directory form → Skill name review-pr
│   ├── SKILL.md            # Main file
│   └── checklist.md        # Supporting file, referenced via ${KIMI_SKILL_DIR}
└── commit.md               # Flat form → Skill name commit
```

--------------------------------

### GET /api/v1/plugins/marketplace

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/reference/server-api.html

Lists the plugin marketplace catalog merged with live install state. The catalog is fetched per request with a 10-second timeout from the configured marketplace URL.

```APIDOC
## GET /api/v1/plugins/marketplace

### Description
Lists the plugin marketplace catalog merged with live install state. The catalog is fetched per request (10-second timeout) from the configured marketplace URL; with the default catalog, built-in capabilities missing from the catalog are merged in as rows (with `capabilityId` set) and rows whose capability is unsupported on this platform are dropped.

### Method
GET

### Endpoint
/api/v1/plugins/marketplace

### Response
#### Success Response (200)
- **data** (object) - Contains `entries` array.
- **entries** (array) - Each item is `{ id, tier, displayName, description?, homepage?, keywords?, version?, source, installed?, updateAvailable?, capabilityId? }`.
  - **id** (string) - Plugin identifier.
  - **tier** (string) - `official` / `curated` / `third-party`.
  - **displayName** (string) - Display name of the plugin.
  - **description** (string, optional) - Description of the plugin.
  - **homepage** (string, optional) - Homepage URL.
  - **keywords** (array, optional) - Keywords associated with the plugin.
  - **version** (string, optional) - Catalog version.
  - **source** (string) - Source identifier used for `POST /api/v1/plugins`.
  - **installed** (object, optional) - `{ version?, enabled }` when the plugin is installed.
  - **updateAvailable** (boolean, optional) - Marks rows whose catalog version is newer than the installed one.
  - **capabilityId** (string, optional) - Set for built-in capabilities merged into the catalog.

#### Response Example
{
  "data": {
    "entries": [
      {
        "id": "plugin-id",
        "tier": "official",
        "displayName": "Plugin Name",
        "source": "source-id",
        "installed": {
          "version": "1.0.0",
          "enabled": true
        },
        "updateAvailable": false
      }
    ]
  }
}

### Error Codes
- **50001** - The marketplace is unreachable or returned an invalid catalog.
```

--------------------------------

### Install OpenCode via installation script

Source: https://www.kimi.com/code/docs/en/third-party-tools/opencode.html

Run this command in a terminal to install OpenCode using the official installation script.

```bash
curl -fsSL https://opencode.ai/install | bash
```

--------------------------------

### Install Kimi Code CLI via npm or pnpm

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/guides/getting-started.html

Global installation using package managers.

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

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

--------------------------------

### GET /api/v1/capabilities

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/reference/server-api.html

Lists every registered capability with its readiness status. Returns a list of capability status objects including detection steps and install progress.

```APIDOC
## GET /api/v1/capabilities

### Description
Lists every registered capability with its readiness status.

### Method
GET

### Endpoint
/api/v1/capabilities

### Response
#### Success Response (200)
- **data.capabilities** (array) - List of capability status objects
- **capability.id** (string) - Capability id
- **capability.pluginId** (string, optional) - Associated plugin id
- **capability.displayName** (string) - Display name
- **capability.description** (string) - Description
- **capability.supported** (boolean) - Whether supported on this platform
- **capability.state** (string) - One of: ready, partial, not_installed, unsupported
- **capability.version** (string, optional) - Version
- **capability.steps** (array) - Detection steps, each with id, state (ok/missing/failed), detail (optional), optional (optional)
- **capability.install** (object) - Install progress: running (boolean), step (optional), percent (0-100), error (optional), note (optional)

#### Response Example
{
  "data": {
    "capabilities": [
      {
        "id": "kimi-cu",
        "displayName": "Kimi Computer Use",
        "description": "...",
        "supported": true,
        "state": "ready",
        "steps": [
          {
            "id": "detect",
            "state": "ok"
          }
        ],
        "install": {
          "running": false,
          "percent": 100
        }
      }
    ]
  }
}
```

--------------------------------

### Install Kimi Code CLI on Windows (PowerShell)

Source: https://www.kimi.com/code/docs/en

Run this command in PowerShell to install the Kimi Code CLI on Windows. After installation, run 'kimi' and use '/login' to connect to the Kimi Code platform.

```powershell
irm https://code.kimi.com/kimi-code/install.ps1 | iex
```

--------------------------------

### Verify Kimi Code CLI installation

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/guides/getting-started.html

Check that the CLI is correctly installed and ready for use by displaying the current version.

```sh
kimi --version
```

--------------------------------

### GET /api/v1/oauth/login

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/reference/server-api.html

Polls the login flow state for a provider. Returns null when no flow has been started.

```APIDOC
## GET /api/v1/oauth/login

### Description
Polls the login flow state for a provider. Returns `null` when no flow has been started.

### Method
GET

### Endpoint
/api/v1/oauth/login

### Parameters
#### Query Parameters
- **provider** (string) - Optional - Managed provider name. Default `managed:kimi-code`

### Response
#### Success Response
On success, `data` is `null` or a flow snapshot: `{ flow_id, provider, status, verification_uri, verification_uri_complete, user_code, expires_in, expires_at, interval }`, where `status` is `pending` / `authenticated` / `denied` / `expired` / `cancelled`. Once the flow leaves `pending`, `resolved_at` records when it reached its terminal state and `error_message` describes a failed flow.

#### Response Example
{
  "data": {
    "flow_id": "string",
    "provider": "managed:kimi-code",
    "status": "pending",
    "verification_uri": "string",
    "verification_uri_complete": "string",
    "user_code": "string",
    "expires_in": 0,
    "expires_at": "string",
    "interval": 0,
    "resolved_at": "string",
    "error_message": "string"
  }
}
```

--------------------------------

### GET /api/v1/capabilities/{capability_id}

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/reference/server-api.html

Reads one capability's readiness status. This is the polling counterpart of the install action.

```APIDOC
## GET /api/v1/capabilities/{capability_id}

### Description
Reads one capability's readiness status. This is the polling counterpart of the install action.

### Method
GET

### Endpoint
/api/v1/capabilities/{capability_id}

### Parameters
#### Path Parameters
- **capability_id** (string) - Required - Capability id

### Response
#### Success Response (200)
- **data** (object) - Capability status object as documented under GET /api/v1/capabilities

#### Error Codes
- **40418**: no capability with that id

#### Response Example
{
  "data": {
    "id": "kimi-cu",
    "displayName": "Kimi Computer Use",
    "description": "...",
    "supported": true,
    "state": "ready",
    "steps": [],
    "install": {
      "running": false,
      "percent": 100
    }
  }
}
```

--------------------------------

### GET /api/v1/plugins

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/reference/server-api.html

Lists installed plugins with their state, counts of skills, MCP servers, hooks, commands, and source information.

```APIDOC
## GET /api/v1/plugins

### Description
Lists installed plugins with their state, counts of skills, MCP servers, hooks, commands, and source information.

### Method
GET

### Endpoint
/api/v1/plugins

### Response
#### Success Response (200)
- **data.plugins** (array) - List of plugin summary objects
- **plugin.id** (string) - Plugin id
- **plugin.displayName** (string) - Display name
- **plugin.version** (string, optional) - Version
- **plugin.enabled** (boolean) - Whether enabled
- **plugin.state** (string) - One of: ok, error
- **plugin.skillCount** (integer) - Number of skills
- **plugin.mcpServerCount** (integer) - Number of MCP servers
- **plugin.enabledMcpServerCount** (integer) - Number of enabled MCP servers
- **plugin.hookCount** (integer) - Number of hooks
- **plugin.commandCount** (integer) - Number of commands
- **plugin.hasErrors** (boolean) - Whether load errors occurred
- **plugin.source** (string) - One of: local-path, zip-url, github
- **plugin.originalSource** (string, optional) - Original source
- **plugin.github** (object, optional) - GitHub provenance: owner, repo, ref (kind: branch|tag|sha, value), installedSha (optional)

#### Response Example
{
  "data": {
    "plugins": [
      {
        "id": "my-plugin",
        "displayName": "My Plugin",
        "enabled": true,
        "state": "ok",
        "skillCount": 2,
        "mcpServerCount": 1,
        "enabledMcpServerCount": 1,
        "hookCount": 0,
        "commandCount": 1,
        "hasErrors": false,
        "source": "github",
        "github": {
          "owner": "owner",
          "repo": "repo",
          "ref": {
            "kind": "branch",
            "value": "main"
          }
        }
      }
    ]
  }
}
```

--------------------------------

### Start the kimi visualizer

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/reference/kimi-command.html

Commands to launch the visualizer, optionally specifying a session or network configuration.

```sh
kimi vis
```

```sh
kimi vis 01HZ...XYZ
```

```sh
kimi vis --host 0.0.0.0 --port 8123 --no-open
```

--------------------------------

### POST /api/v1/remote-control

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/reference/server-api.html

Starts or stops the tunnel. On success, `data` is the same status object as `GET /api/v1/remote-control`. Starting while another live process on this machine holds the single-instance lock fails with `REMOTE_CONTROL_ALREADY_RUNNING` (40928), with the lock holder in `details` in the same shape as `conflict`.

```APIDOC
## POST /api/v1/remote-control

### Description
Starts or stops the tunnel. On success, `data` is the same status object as `GET /api/v1/remote-control`. Starting while another live process on this machine holds the single-instance lock fails with `REMOTE_CONTROL_ALREADY_RUNNING` (40928), with the lock holder in `details` in the same shape as `conflict`.

### Method
POST

### Endpoint
/api/v1/remote-control

### Parameters
#### Request Body
- **enabled** (boolean) - Required - `true` to start the tunnel, `false` to stop it

### Request Example
{
  "enabled": true
}

### Response
#### Success Response (200)
- **data** (object) - Same status object as `GET /api/v1/remote-control`

#### Response Example
{
  "data": {
    "enabled": true,
    "state": "on",
    "url": "string",
    "device_id": "string",
    "device_name": "string"
  }
}
```

--------------------------------

### Launch OpenCode

Source: https://www.kimi.com/code/docs/en/third-party-tools/opencode.html

Start the OpenCode terminal-based coding agent after configuration.

```bash
$ opencode
```

--------------------------------

### GET /api/v1/sessions/{session_id}/transcript/ops?since_seq=

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/reference/server-api.html

Retrieves op-batch catch-up data for a session, starting from a given sequence number. Used for incremental transcript recovery.

```APIDOC
## GET /api/v1/sessions/{session_id}/transcript/ops?since_seq=

### Description
Retrieves op-batch catch-up data for a session, starting from a given sequence number. Used for incremental transcript recovery.

### Method
GET

### Endpoint
/api/v1/sessions/{session_id}/transcript/ops

### Parameters
#### Path Parameters
- **session_id** (string) - Required - The session identifier.

#### Query Parameters
- **since_seq** (number) - Required - The sequence number to start from.

### Response
#### Success Response (200)
Op-batch data with a `complete` flag indicating whether the journal covers the gap.
```

--------------------------------

### Complete example skill definition (SKILL.md)

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/customization/skills.html

A full skill definition with frontmatter (name, description, type, whenToUse, arguments) and a prompt body. Save as $KIMEI_CODE_HOME/skills/review-pr/SKILL.md and place references/checklist.md in the same directory. Invoke with /skill:review-pr #1234.

```markdown
---
name: review-pr
description: Review a Pull Request according to team standards and produce a structured review report
type: prompt
whenToUse: When the user asks me to review a PR, inspect code changes, or evaluate commit quality
arguments:
  - pr_ref
---

Please review the PR the user specified: $pr_ref

1. Fetch and read the full diff for `$pr_ref`.
2. Check each of the following items:
   - Whether corresponding test cases are included
   - Whether public API documentation has been updated
   - Whether new dependencies have been introduced; if so, state the reason
   - Whether error handling covers edge cases
3. Refer to the checklist in the same directory: `references/checklist.md`
4. Produce a review report containing:
   - Overall conclusion (approve / request changes / comment)
   - Required changes (blocking)
   - Suggested improvements (non-blocking)
   - Noteworthy positives
```

--------------------------------

### SYSTEM.md Template Example

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/customization/agents.html

A sample SYSTEM.md file demonstrating the use of template variables to reconstruct the system prompt.

```markdown
You are Kimi, running at ${cwd} on ${os}.

${agents_md}

${skills}

${plugin_sections}
```

--------------------------------

### Configure project-local workspace in local.toml

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/configuration/config-files.html

Example of the [workspace] table in .kimi-code/local.toml for defining additional directories.

```toml
[workspace]
additional_dir = ["/absolute/path/to/shared"]
```

--------------------------------

### Install OpenCode via npm

Source: https://www.kimi.com/code/docs/en/third-party-tools/opencode.html

Alternative installation method using npm to install the opencode-ai package globally.

```bash
npm install -g opencode-ai
```

--------------------------------

### Run kimi install-desktop

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/reference/kimi-command.html

Opens the Kimi Code desktop app download page in the default browser.

```sh
kimi install-desktop
```

--------------------------------

### Run the Kimi web server

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/reference/kimi-command.html

Commands to start the local Kimi server in the foreground with various configuration options.

```sh
kimi web                 # run the server in the foreground and open the browser
kimi web --no-open       # don't open the browser
kimi web --port 58628    # pick a specific bind port
```

--------------------------------

### Install Codex CLI

Source: https://www.kimi.com/code/docs/en/third-party-tools/codex

Use npm to install the Codex command-line interface globally.

```bash
npm install -g @openai/codex
```

--------------------------------

### Launch Kimi Code CLI

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/guides/getting-started.html

Start the interactive UI within a project directory.

```sh
cd your-project
kimi
```

--------------------------------

### Example Plugin Manifest

Source: https://www.kimi.com/code/docs/en/kimi-code-cli/customization/plugins.html

A sample configuration for a finance-related plugin, defining metadata, skills, and interface display properties.

```json
{
  "name": "kimi-finance",
  "version": "1.0.0",
  "description": "Finance data and analysis workflows for Kimi Code CLI",
  "skills": "./skills/",
  "systemPromptPath": "./SYSTEM.md",
  "sessionStart": {
    "skill": "using-finance"
  },
  "interface": {
    "displayName": "Kimi Finance",
    "shortDescription": "Market data and financial analysis workflows"
  }
}
```
Tokens:
Raw