Skip to main content

KCC - A CLI agent for software engineering tasks (forked from kimi-cli)

Project description

CIMI (Kimi CLI Clone)

License Python

Cimi is a CLI agent for software engineering tasks, forked from kimi-cli.

Note: This is a fork of the original Kimi CLI project, renamed and adapted for separate distribution.

Key features

  • Shell-like UI and shell command execution
  • Zsh integration
  • Agent Client Protocol support
  • MCP support
  • And more to come...

Installation

Cimi is published as a Python package on PyPI. We highly recommend installing it with uv. If you have not installed uv yet, please follow the instructions here to install it first.

Once uv is installed, you can install Cimi with:

uv tool install --python 3.13 cimi

Run cimi --help to check if CIMI is installed successfully.

Note: Due to the security checks on macOS, the first time you run cimi command may take 10 seconds or more depending on your system environment.

Upgrading

Upgrade cimi to the latest version with:

uv tool upgrade cimi --no-cache

Usage

Run cimi command in the directory you want to work on, then send /setup to setup Cimi:

After setup, Cimi will be ready to use. You can send /help to get more information.

Differences from kimi-cli

This fork maintains feature parity with the original kim-cli project. The only differences are:

  • Package name: cimi instead of kimi-cli
  • Command name: cimi instead of kimi
  • Source repository: Independent fork for separate development

All functionality and features remain the same as the original project.

Features

Shell mode

Kimi CLI is not only a coding agent, but also a shell. You can switch the mode by pressing Ctrl-X. In shell mode, you can directly run shell commands without leaving Kimi CLI.

[!NOTE] Built-in shell commands like cd are not supported yet.

Zsh integration

You can use Cimi together with Zsh, to empower your shell experience with AI agent capabilities. Please refer to the zsh-kimi-cli plugin for integration instructions.

Note: The zsh plugin is designed for the original kimi-cli but should work with cimi with minimal modifications.

ACP support

Cimi supports Agent Client Protocol out of the box. You can use it together with any ACP-compatible editor or IDE.

For example, to use Cimi with Zed, add the following configuration to your ~/.config/zed/settings.json:

{
  "agent_servers": {
    "Cimi": {
      "command": "cimi",
      "args": ["--acp"],
      "env": {}
    }
  }
}

Then you can create Cimi threads in Zed's agent panel.

Using MCP tools

Kimi CLI supports the well-established MCP config convention. For example:

{
  "mcpServers": {
    "context7": {
      "url": "https://mcp.context7.com/mcp",
      "headers": {
        "CONTEXT7_API_KEY": "YOUR_API_KEY"
      }
    },
    "chrome-devtools": {
      "command": "npx",
      "args": ["-y", "chrome-devtools-mcp@latest"]
    }
  }
}

Run cimi with --mcp-config-file option to connect to the specified MCP servers:

cimi --mcp-config-file /path/to/mcp.json

Development

To develop Cimi, run:

git clone https://github.com/yourusername/cimi.git
cd cimi

make prepare  # prepare the development environment

Then you can start working on Cimi.

Refer to the following commands after you make changes:

uv run cimi  # run CIMI

make format  # format code
make check   # run linting and type checking
make test    # run tests
make help    # show all make targets

Contributing

We welcome contributions to Cimi! Please fork the repository and submit pull requests.

Origin and License

Cimi is a fork of kimi-cli by Moonshot AI, licensed under the Apache License 2.0.

LICENSE

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cimi-0.54.1.tar.gz (102.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cimi-0.54.1-py3-none-any.whl (141.7 kB view details)

Uploaded Python 3

File details

Details for the file cimi-0.54.1.tar.gz.

File metadata

  • Download URL: cimi-0.54.1.tar.gz
  • Upload date:
  • Size: 102.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for cimi-0.54.1.tar.gz
Algorithm Hash digest
SHA256 cd1a865669614d8d6c4de780a743237b43c996c2df2b0f1ee987cd0ac4bb6344
MD5 f704c83bf0e151f0d85fa19a8d91589b
BLAKE2b-256 319494df885d934b4490d9d98310fdea455578dbaadda13c1c7d1143ea89153f

See more details on using hashes here.

File details

Details for the file cimi-0.54.1-py3-none-any.whl.

File metadata

  • Download URL: cimi-0.54.1-py3-none-any.whl
  • Upload date:
  • Size: 141.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for cimi-0.54.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c2975eb575a5988d5b0932a544633358b20caf11b0ee9bc9c8ecac4f77d0c8da
MD5 c0abc60bb865c0a3de50e87ffed733b6
BLAKE2b-256 75e131fe9134d0cf880a7c479e489227077d41de25615ec8e09ea7487ad5fafb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page