Skip to content

docs(readme): surface install command in Getting Started#2295

Open
ktwu01 wants to merge 1 commit into
MoonshotAI:mainfrom
ktwu01:docs/readme-install-command-2271
Open

docs(readme): surface install command in Getting Started#2295
ktwu01 wants to merge 1 commit into
MoonshotAI:mainfrom
ktwu01:docs/readme-install-command-2271

Conversation

@ktwu01
Copy link
Copy Markdown

@ktwu01 ktwu01 commented May 15, 2026

Summary

The current ## Getting Started section of the README contains no install command, only an inline link to the docs page. A first-time visitor has to click through and scroll past the "What is Kimi Code CLI" intro to reach the actual curl ... | bash command — two redirects + one scroll for a single install.

This PR surfaces the canonical install commands (Linux/macOS, Windows, and the uv tool install alternative) directly in the README, pulled verbatim from docs/en/guides/getting-started.md so the README stays in sync with the docs as the single source of truth. The link to the full guide remains for login setup, ACP / VS Code integration, and the rest.

Test plan

  • make format is a no-op on a docs-only change.
  • Rendered the new section in GitHub's markdown preview locally.
  • Install commands match docs/en/guides/getting-started.md line-for-line — no invented commands.

Fixes #2271


Open in Devin Review

The Getting Started section linked to the docs page with no install
command in the README itself, requiring a click-through plus scrolling
past the intro to reach the actual install line. Inline install commands
(pulled from docs/en/guides/getting-started.md so the README stays in
sync) for Linux/macOS, Windows, and uv.

Fixes MoonshotAI#2271
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

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.

[Docs] README "Getting Started" is a double redirect — install command is two clicks + one scroll away

1 participant