kimi-cli

(β˜… 11,234)

Kimi Code CLI is your next CLI agent.

  • .gitignore
  • .pre-commit-config.yaml
  • .python-version
  • AGENTS.md
  • CHANGELOG.md
  • CONTRIBUTING.md
  • flake.lock
  • flake.nix
  • kimi.spec
  • LICENSE
  • Makefile
  • NOTICE
  • pyproject.toml
  • pytest.ini
  • README.md
  • SECURITY.md
  • uv.lock

# Installation Guide

1. Get the code
git clone https://github.com/MoonshotAI/kimi-cli

Downloads the entire project code from GitHub to your computer.

cd kimi-cli

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
make build-web # build the web UI and sync it into the package (requires Node.js/npm)

Compiles the code based on the generated build configuration to produce an executable.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install .

Installs the package published on PyPI directly β€” no need to clone the source.

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make prepare # prepare the development environment

Compiles the code based on the generated build configuration to produce an executable.

make format # format code

Compiles the code based on the generated build configuration to produce an executable.

make check # run linting and type checking

Compiles the code based on the generated build configuration to produce an executable.

make test # run tests

Compiles the code based on the generated build configuration to produce an executable.

make test-kimi-cli # run Kimi CLI tests only

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation