MoonshotAI / MoonshotAI/kimi-cli

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

Open Beginner friendly
#2,271 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
11.4k
Forks
1.3k
Avg merge
9h 47m
Merged PRs (30d)
2

Description

Summary

The README's "Getting Started" section does not contain the install command. It only contains a single sentence with the words "Getting Started" hyperlinked inline, and that link leads to a docs page whose first content is a "What is Kimi Code CLI" intro — the install command is below the fold and requires further scrolling.

Result: a first-time visitor has to (1) notice the inline link is a link, (2) click through, (3) scroll past intro content, before they can copy/paste the install command. That is two redirects + one scroll for a single pip install kimi-cli.

Repro

  1. Go to https://github.com/MoonshotAI/kimi-cli

  2. Find the ## Getting Started section. It reads (verbatim):

    See Getting Started for how to install and start using Kimi Code CLI.

  3. There is no install command in the README. The only "Getting Started" link is embedded inline inside a sentence, not surfaced as a heading link, button, or code block.

  4. Click the link → land on getting-started.html. The page leads with:

    • Heading: "What is Kimi Code CLI"
    • Paragraph: "Kimi Code CLI is an AI agent that runs in the terminal…"
    • Two bulleted lists (use cases, usage modes)
  5. Scroll further to find the actual Installation section with the pip install kimi-cli / uv tool install commands.

Why this hurts onboarding

  • Almost every comparable CLI (Claude Code, Codex CLI, Aider, Gemini CLI, Kiro) puts the install command directly in the README, in a fenced code block, near the top. That is the de-facto convention.
  • The current Kimi CLI README link is easy to miss because it's an inline link inside a normal sentence — users scanning for a button, heading-link, or code block skip past it.
  • Even after the click, the docs page violates "install command above the fold" by leading with marketing-style intro content.

Net effect: time-to-first-token is longer than it needs to be, and some fraction of visitors bounce before they ever run kimi.

Proposed fix (README-only, minimal)

Replace the current section:

## Getting Started

See [Getting Started](https://moonshotai.github.io/kimi-cli/en/guides/getting-started.html) for how to install and start using Kimi Code CLI.

with something like:

## Getting Started

Install:

```bash
pip install kimi-cli
# or
uv tool install kimi-cli
```

Then run `kimi` in your terminal.

For login setup, ACP / VS Code integration, and alternative installers, see the [full Getting Started guide](https://moonshotai.github.io/kimi-cli/en/guides/getting-started.html).

(Use whichever install commands are canonical — pulling them from the docs page so the README stays the single source of truth for "how do I run this in 10 seconds".)

Optional secondary fix (docs site)

On en/guides/getting-started.html, move the Installation section above the What is Kimi Code CLI section, or add a "Quick install" code block at the very top of the page so the install command is visible without scrolling.

Not a duplicate

I searched open + closed issues for README documentation, install scroll, getting started README install — none of the existing issues cover this onboarding-funnel concern.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in the repository README at the ## Getting Started section, then check en/guides/getting-started.html for the canonical installation commands. Update the README so a first-time visitor can find and copy the install command immediately, while retaining a link to the full guide. Done means the README communicates installation and launching kimi without the extra navigation and scrolling described in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
86/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.