docs(zh+en): improve CLI section — slash-commands, plugins, datasource, IDE integration, full EN translation#391
Conversation
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: caa96613ad
ℹ️ About Codex in GitHub
Codex has been enabled to automatically 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 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| | `/reload` | — | Reload the current session and apply the latest `config.toml` settings (providers, models, etc.) and `tui.toml` UI preferences, without restarting the CLI | No | | ||
| | `/reload-tui` | — | Reload only the `tui.toml` UI preferences (theme, editor, notifications, etc.) without rebuilding the session | Yes | |
There was a problem hiding this comment.
These two rows document /reload and /reload-tui, but the TUI only resolves commands declared in apps/kimi-code/src/tui/commands/registry.ts and that list has no reload or reload-tui entries, nor does the dispatch switch handle them. In any CLI session, following this reference will therefore hit the unknown slash command path instead of reloading config/UI state, so the rows should be removed or backed by real commands.
Useful? React with 👍 / 👎.
|
|
||
| ## Installation | ||
|
|
||
| 1. Run `/plugin` inside Kimi Code CLI |
There was a problem hiding this comment.
The installation flow sends users to /plugin, but the built-in command registry defines only plugins with no plugin alias (apps/kimi-code/src/tui/commands/registry.ts). Anyone following this new datasource page will get an unknown slash command before reaching the marketplace; use /plugins here and in the later confirmation step.
Useful? React with 👍 / 👎.
| ::: tip | ||
| If you want to use Anthropic, OpenAI, Google, or other providers, edit `config.toml` directly to configure the API key. See [Providers and models](../configuration/providers.md) for details. Runtime configuration such as the model and provider is also written to `config.toml`. See [Config files](../configuration/config-files.md), [Environment variables](../configuration/env-vars.md), and [Configuration overrides](../configuration/overrides.md) for details. | ||
| ::: tip Using other AI providers | ||
| If you want to connect Anthropic, OpenAI, Google, or other providers, edit `~/.kimi-code/config.toml` directly to configure the API key. See [Providers and models](./configuration/providers-and-models.md) for details. For the full reference of all config options, see [Configuration files](./configuration/configuration-files.md), [Environment variables](./configuration/environment-variables.md), and [Configuration overrides](./configuration/overrides-and-precedence.md). |
There was a problem hiding this comment.
These links resolve relative to docs/en/guides/, for example ./configuration/providers-and-models.md becomes docs/en/guides/configuration/providers-and-models.md, and those files do not exist; the actual configuration pages are under docs/en/configuration/ with current slugs such as providers.md, config-files.md, env-vars.md, and overrides.md. This makes the primary first-run docs send users to 404 pages when they try to configure providers or read config references.
Useful? React with 👍 / 👎.
|
|
||
| ::: tip Who calls this? | ||
| You typically never run `kimi acp` by hand — it's the subprocess entry point an IDE will spawn. For the IDE-side configuration, see [Using in IDEs](../guides/ides.md). | ||
| You typically do not need to run `kimi acp` manually — this command is the subprocess entry point for IDEs. For IDE-side configuration, see [Using in IDEs](../use-in-ides.md). |
There was a problem hiding this comment.
This link resolves to docs/en/use-in-ides.md, but the IDE integration page added here lives at docs/en/guides/ides.md and there is no use-in-ides.md file in the repo. Users reading the new kimi acp reference therefore hit a 404 exactly when they need the IDE-side configuration instructions; point this at ../guides/ides.md instead.
Useful? React with 👍 / 👎.
| - [kimi acp reference](./reference/kimi-acp.md) — ACP capability matrix and method coverage details | ||
| - [kimi command reference](./reference/kimi-command.md) — full subcommand list |
There was a problem hiding this comment.
These links are relative to docs/en/guides/, so ./reference/kimi-acp.md and ./reference/kimi-command.md point under a non-existent docs/en/guides/reference/ directory. Users troubleshooting ACP setup from the new IDE guide will hit 404s instead of the reference pages; these should link to ../reference/kimi-acp.md and ../reference/kimi-command.md.
Useful? React with 👍 / 👎.
| ## Approval Panel | ||
|
|
||
| When the agent issues a tool call that requires confirmation, the TUI shows an approval panel. For the full approval flow, see [Interaction and Input](../guides/interaction.md#approval-flow); the table below lists the keys available inside the panel: | ||
| When the Agent initiates a tool call that requires confirmation, the TUI displays an approval panel. For the full approval workflow, see [Interaction & Input](../interaction.md#审批流程). The available keys inside the panel are: |
There was a problem hiding this comment.
This link resolves to docs/en/interaction.md and uses the Chinese #审批流程 anchor, but the English interaction page is docs/en/guides/interaction.md with an English approval-flow heading. Clicking it from the keyboard reference will 404 instead of explaining the approval panel workflow.
Useful? React with 👍 / 👎.
| ## Scheduled Tasks | ||
|
|
||
| Scheduled task tools let the agent re-inject a prompt into the current session at a future time, either once (a reminder) or on a recurring cron schedule (a periodic check, daily report, deploy watcher, etc.). Schedules are scoped to the session: they survive `kimi resume` of the same session, but never carry over into a brand-new session. A session is capped at 50 live scheduled tasks. Setting `KIMI_DISABLE_CRON=1` blocks the entire feature — see [Environment variables](../configuration/env-vars.md#runtime-switches). | ||
| Scheduled task tools allow the Agent to re-inject a prompt into the current session at a future time — either as a one-time reminder or as a recurring cron-triggered task (periodic checks, daily reports, deployment monitoring, etc.). Schedules are bound to the session and remain active after `kimi resume`, but are not carried into a brand-new session. A single session can hold at most 50 active scheduled tasks. Set `KIMI_DISABLE_CRON=1` to disable them entirely; see [Environment Variables](../configuration/environment-variables.md#运行时开关). |
There was a problem hiding this comment.
The Environment Variables link points to ../configuration/environment-variables.md#运行时开关, but the page in this docs tree is env-vars.md and its English heading is Runtime switches. Users looking up how KIMI_DISABLE_CRON works from the scheduled-task reference will land on a missing page/anchor; link to ../configuration/env-vars.md#runtime-switches instead.
Useful? React with 👍 / 👎.
zh: - slash-commands: add /btw, /reload, /reload-tui - kimi-command: add kimi login, kimi acp subcommands - interaction: add image/video paste section, expand modes - env-vars: restructure KIMI_CODE_HOME, KIMI_DISABLE_TELEMETRY, KIMI_MODEL_* - mcp: fix anchor link text - plugins: rewrite official plugins section with install steps - datasource: fix /plugin → /plugins (new file from upstream) - ides: minor improvements en: - datasource: fix /plugin → /plugins Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
wenhua020201-arch
force-pushed
the
docs/cli-zh-en-v2
branch
from
caa9661 to
66c75be
Compare
commit: |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 66c75be446
ℹ️ About Codex in GitHub
Codex has been enabled to automatically 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 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| - [配置覆盖](./overrides-and-precedence.md) — 环境变量、CLI 选项、配置文件的优先级关系 | ||
| - [数据路径](./data-locations.md) — `KIMI_CODE_HOME` 影响的完整目录结构 | ||
| - [平台与模型](./providers.md) — 各供应商类型的完整接入示例 | ||
| - [平台与模型](./providers-and-models.md) — 各供应商类型的完整接入示例 |
There was a problem hiding this comment.
These new links point to overrides-and-precedence.md and providers-and-models.md, but the Chinese configuration directory contains overrides.md and providers.md (confirmed with rg --files docs/zh/configuration). Readers using the env-vars next steps now land on 404s instead of the configuration pages.
Useful? React with 👍 / 👎.
| ## 下一步 | ||
|
|
||
| - [Plugins](./plugins.md) — Plugin 系统的完整安装与开发文档 | ||
| - [Plugins](./pluginss.md) — Plugin 系统的完整安装与开发文档 |
There was a problem hiding this comment.
./pluginss.md does not exist under docs/zh/customization; the plugin documentation page is plugins.md. Anyone following the datasource page's next-step link will hit a 404, so this should keep the original ./plugins.md target.
Useful? React with 👍 / 👎.
| ``` | ||
|
|
||
| 权限规则的完整语法见[配置文件](../configuration/config-files.md#permission)。 | ||
| 权限规则的完整语法见[配置文件](../configuration/configuration-files.md#permission)。 |
There was a problem hiding this comment.
../configuration/configuration-files.md is not present in the Chinese docs tree; the permission reference lives in ../configuration/config-files.md#permission. This breaks the MCP guide's permission-rule reference for users trying to configure allow/deny rules.
Useful? React with 👍 / 👎.
| - [kimi acp 参考](./reference/kimi-acp.md) — ACP 能力矩阵和方法覆盖详情 | ||
| - [kimi 命令参考](./reference/kimi-command.md) — 完整子命令列表 |
There was a problem hiding this comment.
From docs/zh/guides/ides.md, ./reference/kimi-acp.md and ./reference/kimi-command.md resolve under the nonexistent docs/zh/guides/reference/ directory; the actual reference pages are siblings under docs/zh/reference/. These next-step links now 404 for users troubleshooting ACP setup.
Useful? React with 👍 / 👎.
| 已激活的 [Agent Skills](./customization/skills.md) 会自动注册为斜杠命令，以 `/skill:<name>` 调用；若 Skill 名称与内置命令不冲突，也可以省略 `skill:` 前缀直接输入 `/<name>`。 | ||
|
|
||
| 部分命令仅在 Agent 空闲时可用，流式输出或上下文压缩期间需先按 `Esc` 中断。`/yolo`、`/plan`、`/help`、`/btw` 等模式切换和查询类命令则始终可用。全部命令说明见[斜杠命令参考](../reference/slash-commands.md)。 | ||
| 部分命令仅在 Agent 空闲时可用，流式输出或上下文压缩期间需先按 `Esc` 中断。`/yolo`、`/plan`、`/help`、`/btw` 等模式切换和查询类命令则始终可用。全部命令说明见[斜杠命令参考](./reference/slash-commands.md)。 |
There was a problem hiding this comment.
Because this file is in docs/zh/guides/, the new ./customization/skills.md and ./reference/slash-commands.md targets resolve to nonexistent paths below guides/. The actual pages are in sibling directories, so these should remain ../customization/... and ../reference/... or readers of the interaction guide will hit 404s.
Useful? React with 👍 / 👎.
| | `/login` | — | 选择账号或平台并登录：Kimi Code 走 OAuth 验证码流程，Kimi Platform 通过 API 密钥登录 | 否 | | ||
| | `/logout` | — | 清除当前所选账号的凭据 | 否 | | ||
| | `/provider` | — | 打开交互式供应商管理器，查看、添加和删除已配置的供应商。详见[平台与模型 — `/provider` 与供应商管理](../configuration/providers.md#provider-与供应商管理) | 是 | | ||
| | `/provider` | — | 打开交互式供应商管理器，查看、添加和删除已配置的供应商。详见[平台与模型 — `/provider` 与供应商管理](../configuration/providers-and-models.md#provider-与供应商管理) | 是 | |
There was a problem hiding this comment.
The changed target ../configuration/providers-and-models.md is not in the Chinese docs tree; the provider page is ../configuration/providers.md. This makes the /provider row's detailed setup link 404 from the slash-command reference.
Useful? React with 👍 / 👎.
| 用方向键选择选项，`Enter` 确认；也可以按 `1`/`2`/`3` 数字键直接选择。`Esc`、`Ctrl-C`、`Ctrl-D` 等同于拒绝。 | ||
|
|
||
| 面板中通常有「Approve for this session」选项，选择后本次会话内的同类调用将自动放行。如需永久规则，在[配置文件](../configuration/config-files.md#permission)里预置 allow / deny 规则即可。 | ||
| 面板中通常有「Approve for this session」选项，选择后本次会话内的同类调用将自动放行。如需永久规则，在[配置文件](./configuration/configuration-files.md#permission)里预置 allow / deny 规则即可。 |
There was a problem hiding this comment.
This new target resolves to docs/zh/guides/configuration/configuration-files.md, but there is no guides/configuration/ directory and the permission section is in docs/zh/configuration/config-files.md#permission. Users following the approval-flow guidance to make a permanent allow/deny rule will hit a 404.
Useful? React with 👍 / 👎.
| - [键盘快捷键](./reference/keyboard-shortcuts.md) — 全部快捷键的完整速查表 | ||
| - [斜杠命令](./reference/slash-commands.md) — 所有内置命令的说明与别名 |
There was a problem hiding this comment.
From docs/zh/guides/interaction.md, these new ./reference/... links resolve under docs/zh/guides/reference/, and keyboard-shortcuts.md also does not exist; the actual pages are ../reference/keyboard.md and ../reference/slash-commands.md. This breaks the guide's next-step navigation after the interaction overview.
Useful? React with 👍 / 👎.
|
|
||
| - [斜杠命令](./slash-commands.md) — 交互式 TUI 内的控制命令速查 | ||
| - [配置文件](../configuration/config-files.md) — `default_model`、权限模式等启动参数的持久化配置 | ||
| - [配置文件](../configuration/configuration-files.md) — `default_model`、权限模式等启动参数的持久化配置 |
There was a problem hiding this comment.
The next-step link now points to ../configuration/configuration-files.md, but rg --files docs/zh/configuration shows the page is still config-files.md. Readers finishing the kimi command reference will hit a 404 instead of the persistent configuration reference.
Useful? React with 👍 / 👎.
| ## 下一步 | ||
|
|
||
| - [键盘快捷键](./keyboard.md) — TUI 键盘操作速查 | ||
| - [键盘快捷键](./keyboard-shortcuts.md) — TUI 键盘操作速查 |
There was a problem hiding this comment.
./keyboard-shortcuts.md is not present in docs/zh/reference; the keyboard shortcut page is still keyboard.md. This changed next-step link in the slash-command reference now sends readers to a 404.
Useful? React with 👍 / 👎.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 23753322ae
ℹ️ About Codex in GitHub
Codex has been enabled to automatically 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 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
|
||
| --- | ||
| 1. 运行 `/plugins`，选择 **Marketplace** | ||
| 2. 找到 **Kimi Datasource**，按 `Space` 安装 |
There was a problem hiding this comment.
In the marketplace picker, PluginMarketplaceSelectorComponent.handleInput only installs on Key.enter; Key.space is not handled there and is only used for toggling installed plugins in the overview. Users following this new install step will press Space and nothing will happen, so the documented key should be Enter unless the picker is changed to accept Space.
Useful? React with 👍 / 👎.
| 1. 运行 `/plugins`，选择 **Marketplace** | ||
| 2. 找到 **Kimi Datasource**，按 `Space` 安装 | ||
| 3. 安装完成后运行 `/new` 开启新会话 |
There was a problem hiding this comment.
docs/AGENTS.md requires non-changelog pages under docs/en/ and docs/zh/ to be mirrored and updated together, but this new Chinese install flow is not reflected in docs/en/customization/plugins.md, which still has the old one-line /plugins marketplace text and bullet layout. This leaves the two locale versions with different section structure and installation guidance, so the English mirror should be updated in the same change.
Useful? React with 👍 / 👎.
1 participant
Summary
Comprehensive update to the Kimi Code CLI documentation, covering both Chinese (zh) content improvements and a full English (en) translation.
zh improvements
/btw,/reload,/reload-tuikimi login,kimi acpsubcommandsKIMI_CODE_HOME,KIMI_DISABLE_TELEMETRY,KIMI_MODEL_*sectionskimi acpcapability matrix and ACP method coverageen translation
Full zh→en translation of all 22 CLI pages. New English pages added for
interaction,sessions,use-cases,use-in-ides,customization/datasource,reference/kimi-acp. All existing English pages updated to match current Chinese versions.Test plan
/reload,/reload-tui,/btwin slash-commands tablekimi login,kimi acpin kimi-command reference🤖 Generated with Claude Code