Skip to content

docs: clarify cli distribution options - #2664

Open
tompsantos wants to merge 2 commits into
MoonshotAI:mainfrom
tompsantos:docs/clarify-cli-distribution
Open

docs: clarify cli distribution options#2664
tompsantos wants to merge 2 commits into
MoonshotAI:mainfrom
tompsantos:docs/clarify-cli-distribution

Conversation

@tompsantos

Copy link
Copy Markdown

Summary

Clarifies that Kimi Code CLI is available both as a standalone binary and as an npm package.

The previous wording described the CLI only as being distributed via npm and running on Node.js, which could conflict with the recommended standalone install flow documented immediately below.

Changes

  • update one sentence in the Getting Started guide
  • keep the installation options consistent with the rest of the documentation

Validation

  • documentation-only change
  • one file changed
  • no changeset required

@changeset-bot

changeset-bot Bot commented Aug 5, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: a3053ec

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 3ac20b6650

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

- **Automating tasks**: batch-processing files, running builds and tests, chaining multiple scripts together

The CLI is written in TypeScript, distributed via npm, and runs on Node.js.
The CLI is written in TypeScript and is available either as a standalone binary or as an npm package.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Update the mirrored Chinese guide

This English Getting Started sentence now clarifies that the CLI can be installed as either a standalone binary or an npm package, but the mirrored Chinese page still says it is distributed through npm and runs on Node.js. Chinese readers will continue to see the old conflicting distribution description even though the install flow below recommends a no-Node standalone script, so the zh mirror should be updated in the same change.

AGENTS.md reference: docs/AGENTS.md:L19-L21

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the mirrored Chinese guide to keep both versions consistent. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant