Skip to content

Breaking Changes and Migration

This page documents breaking changes in Kimi CLI releases and provides migration guidance.

0.74 - ACP command change

--acp option deprecated

The --acp option has been deprecated. Use the kimi acp subcommand instead.

  • Affected: Scripts and IDE configurations using kimi --acp
  • Migration: kimi --acpkimi acp

0.66 - Config File and Provider Type

Config file format migration

The config file format has been migrated from JSON to TOML.

  • Affected: Users with ~/.kimi/config.json
  • Migration: Kimi CLI will automatically read the old JSON config, but manual migration to TOML is recommended
  • New location: ~/.kimi/config.toml

JSON config example:

json
{
  "default_model": "kimi-k2-0711",
  "providers": {
    "kimi": {
      "type": "kimi",
      "base_url": "https://api.kimi.com/coding/v1",
      "api_key": "your-key"
    }
  }
}

Equivalent TOML config:

toml
default_model = "kimi-k2-0711"

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

google_genai provider type renamed

The provider type for Gemini Developer API has been renamed from google_genai to gemini.

  • Affected: Users with type = "google_genai" in their config
  • Migration: Change the type value to "gemini"
  • Compatibility: google_genai still works but updating is recommended

0.57 - Tool Changes

Shell tool

The Bash tool (or CMD on Windows) has been unified and renamed to Shell.

  • Affected: Agent files referencing Bash or CMD tools
  • Migration: Change tool references to Shell

Task tool moved to multiagent module

The Task tool has been moved from kimi_cli.tools.task to kimi_cli.tools.multiagent.

  • Affected: Custom tools importing the Task tool
  • Migration: Change import path to from kimi_cli.tools.multiagent import Task

PatchFile tool removed

The PatchFile tool has been removed.

  • Affected: Agent configs using the PatchFile tool
  • Alternative: Use StrReplaceFile tool for file modifications

0.52 - CLI Option Changes

--ui option removed

The --ui option has been removed in favor of separate flags.

  • Affected: Scripts using --ui print, --ui acp, or --ui wire
  • Migration:
    • --ui print--print
    • --ui acpkimi acp
    • --ui wire--wire

0.42 - Keyboard Shortcut Changes

Mode switch shortcut

The agent/shell mode toggle shortcut has changed from Ctrl-K to Ctrl-X.

  • Affected: Users accustomed to using Ctrl-K for mode switching
  • Migration: Use Ctrl-X to toggle modes

0.27 - CLI Option Rename

--agent option renamed

The --agent option has been renamed to --agent-file.

  • Affected: Scripts using --agent to specify custom agent files
  • Migration: Change --agent to --agent-file
  • Note: --agent is now used to specify built-in agents (e.g., default, okabe)

0.25 - Package Name Change

Package renamed from ensoul to kimi-cli

  • Affected: Code or scripts using the ensoul package name
  • Migration:
    • Installation: pip install ensoulpip install kimi-cli or uv tool install kimi-cli
    • Command: ensoulkimi

ENSOUL_* parameter prefix changed

The system prompt built-in parameter prefix has changed from ENSOUL_* to KIMI_*.

  • Affected: Custom agent files using ENSOUL_* parameters
  • Migration: Change parameter prefix to KIMI_* (e.g., ENSOUL_NOWKIMI_NOW)