Skip to content

Commit e5e9d28

Browse files
docs: merge Kimi Datasource into plugins page and add terminal tip (#551)
* docs: merge Kimi Datasource into plugins page and add terminal tip to getting started - Merge datasource.md content into plugins.md as a dedicated section, placed between installation management and plugin manifest sections - Replace verbose feature tables with scenario-driven use cases and a condensed coverage table - Add /skill:kimi-datasource as an explicit invocation method alongside natural language; update /new references to /reload - Promote GitHub URL formats and notes to named H3 subsections within installation management - Add terminal recommendation tip (Kitty / Ghostty) in the Installation section of getting-started - Remove standalone datasource.md sidebar entries from zh and en nav * docs: remove stale datasource pages and add redirects to plugins Delete zh/en datasource.md (content now merged into plugins.md) and add VitePress redirects so existing bookmarks and search results for /customization/datasource land on /customization/plugins instead. * docs: restore datasource pages as forwarding stubs Replace deleted files with minimal pages that link to the merged section in plugins.md. VitePress redirects only fire in SSG builds; dev-server visitors hitting the old URL would 404 without these stubs. * docs: add dev-server redirect middleware for removed datasource pages VitePress `redirects` config only fires during SSG build; the dev server ignores it, causing 404s on the old /customization/datasource URLs. Add a Vite `configureServer` middleware that handles the redirect in dev mode, while the top-level `redirects` config continues to generate meta-refresh HTML pages for the production build. --------- Co-authored-by: qer <wbxl2000@outlook.com>
1 parent 0e16651 commit e5e9d28

7 files changed

Lines changed: 131 additions & 432 deletions

File tree

docs/.vitepress/config.ts

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,6 @@ const config = withMermaid(defineConfig({
6666
{ text: 'Model Context Protocol', link: '/zh/customization/mcp' },
6767
{ text: 'Agent Skills', link: '/zh/customization/skills' },
6868
{ text: 'Plugins', link: '/zh/customization/plugins' },
69-
{ text: 'Kimi Datasource', link: '/zh/customization/datasource' },
7069
{ text: 'Agent 与子 Agent', link: '/zh/customization/agents' },
7170
{ text: 'Hooks', link: '/zh/customization/hooks' },
7271
],
@@ -143,7 +142,6 @@ const config = withMermaid(defineConfig({
143142
{ text: 'Model Context Protocol', link: '/en/customization/mcp' },
144143
{ text: 'Agent Skills', link: '/en/customization/skills' },
145144
{ text: 'Plugins', link: '/en/customization/plugins' },
146-
{ text: 'Kimi Datasource', link: '/en/customization/datasource' },
147145
{ text: 'Agents and Subagents', link: '/en/customization/agents' },
148146
{ text: 'Hooks', link: '/en/customization/hooks' },
149147
],
@@ -186,6 +184,11 @@ const config = withMermaid(defineConfig({
186184
},
187185
},
188186

187+
redirects: {
188+
'/zh/customization/datasource': '/zh/customization/plugins',
189+
'/en/customization/datasource': '/en/customization/plugins',
190+
},
191+
189192
themeConfig: {
190193
outline: [2, 3],
191194
search: { provider: 'local' },
@@ -198,7 +201,28 @@ const config = withMermaid(defineConfig({
198201
optimizeDeps: {
199202
include: mermaidOptimizeDeps.map((dep) => `mermaid > ${dep}`),
200203
},
201-
plugins: [llmstxt()],
204+
plugins: [
205+
llmstxt(),
206+
{
207+
name: 'dev-redirects',
208+
configureServer(server) {
209+
const map: Record<string, string> = {
210+
'/zh/customization/datasource': '/zh/customization/plugins',
211+
'/en/customization/datasource': '/en/customization/plugins',
212+
}
213+
server.middlewares.use((req, res, next) => {
214+
const url = (req.url ?? '').split('?')[0].replace(/\.html$/, '')
215+
const target = map[url]
216+
if (target) {
217+
res.writeHead(302, { Location: target })
218+
res.end()
219+
return
220+
}
221+
next()
222+
})
223+
},
224+
},
225+
],
202226
},
203227
}))
204228

docs/en/customization/datasource.md

Lines changed: 0 additions & 196 deletions
This file was deleted.

docs/en/customization/plugins.md

Lines changed: 48 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,11 @@ You can also use slash commands directly:
3131
| `/plugins mcp enable <id> <server>` | Enable an MCP server declared by a plugin |
3232
| `/plugins mcp disable <id> <server>` | Disable an MCP server declared by a plugin |
3333

34-
**GitHub URL supports four forms:**
34+
The plugin manager shows the installation source and a trust badge for each install: `kimi-official` (from an official address), `curated` (from a curated address), or `third-party` (everything else).
35+
36+
### Installing from GitHub
37+
38+
Use `/plugins install <url>` to install directly from a GitHub repository. Four URL forms are supported:
3539

3640
- `https://github.com/<owner>/<repo>`: Install the latest release; falls back to the default branch if no release exists
3741
- `https://github.com/<owner>/<repo>/tree/<ref>`: Install a specific branch, tag, or short commit SHA
@@ -40,14 +44,54 @@ You can also use slash commands directly:
4044

4145
Network requests only go through `github.com` redirects and `codeload.github.com` downloads; `api.github.com` is not called.
4246

43-
**A few notes:**
47+
### Notes
4448

45-
- Plugin changes only take effect for new sessions. After installing, enabling/disabling, removing, or reloading a plugin, start a new session with `/new`; the current session will not update.
49+
- Plugin changes only take effect for new sessions. After installing, enabling/disabling, or removing a plugin, run `/reload` to reload plugins or `/new` to start a new session; the current session will not update.
4650
- Local installations are copied to `$KIMI_CODE_HOME/plugins/managed/<id>/`, and the CLI always runs from this managed copy. Editing the original source directory after installation has no effect; you must reinstall.
4751
- Removing a plugin only deletes the installation record; the managed copy and original source files remain on disk.
4852
- Plugins are currently installed per-user and apply to all projects; project-level installation scope is not yet supported.
4953

50-
The plugin manager shows the installation source and a trust badge for each install: `kimi-official` (from an official address), `curated` (from a curated address), or `third-party` (everything else).
54+
## Kimi Datasource
55+
56+
Kimi Datasource is the official Kimi Code data plugin. It lets you query financial market data, macroeconomic indicators, corporate registration records, and academic literature in natural language — no manual API calls or data account registration required.
57+
58+
### Installation
59+
60+
You must first complete OAuth login with a Kimi Code account via `/login`. The plugin relies on local credentials to access data services.
61+
62+
1. Run `/plugins` and select **Marketplace**
63+
2. Find **Kimi Datasource** and press `Space` to install
64+
3. After installation completes, run `/reload` to activate the plugin
65+
66+
### How to Use
67+
68+
Once installed, describe your need in natural language and Kimi Code will automatically invoke the data capabilities. You can also explicitly trigger the data query skill with `/skill:kimi-datasource`.
69+
70+
### What You Can Do
71+
72+
**Live market research**: Want to run a quantitative analysis on a stock? Pull three years of daily closing prices, MACD, and KDJ signals in a single query — no third-party data platforms needed.
73+
74+
**Cross-country macro comparison**: Studying supply-chain shifts across China, India, and Vietnam? Get complete GDP growth, trade volume, and demographic time-series from World Bank data spanning 50+ years, all in one go.
75+
76+
**Pre-contract risk check**: Need to vet a counterparty fast? Type the company name and instantly get business registration, equity structure, litigation disputes, and credit blacklist status — right when you need it.
77+
78+
**Literature review acceleration**: Tracing the research arc of RLHF? Get the most-cited papers, key authors, and core findings in seconds, so your literature review outline takes shape in half the time.
79+
80+
### Coverage
81+
82+
| Category | Scope |
83+
|---|---|
84+
| Stock market data | A-shares, HK, US, and major global markets — real-time/historical prices, technical indicators, financial statements, stock screening |
85+
| Macroeconomic data | World Bank data for 189 countries, 50+ years of time series (GDP, trade, population, climate, and more) |
86+
| Corporate data | Business registration, equity chain, legal risk, and related-entity graph for mainland Chinese companies |
87+
| Academic literature | Millions of papers across physics, mathematics, CS, quantitative finance, economics — including preprints |
88+
89+
### Notes
90+
91+
- Data queries are billed per call and consume Kimi Code account credits
92+
- The plugin provides read-only queries; no write or trading functionality is available
93+
- Technical indicators and real-time prices are only available during active trading hours
94+
- AI-generated output is for reference only and does not constitute investment or business advice
5195

5296
## Plugin Manifest
5397

@@ -151,20 +195,6 @@ Plugin MCP servers only start in new sessions. To enable or disable a server:
151195
/new
152196
```
153197

154-
## Official Plugins
155-
156-
The Kimi Code CLI official marketplace hosts reviewed official plugins. Currently available:
157-
158-
**[Kimi Datasource](./datasource.md)** — Query financial market data, macroeconomic indicators, corporate registration records, and academic literature in natural language.
159-
160-
Installation:
161-
162-
1. Run `/plugins` and select **Marketplace**
163-
2. Find **Kimi Datasource** and press `Space` to install
164-
3. Run `/new` to start a new session after installation
165-
166-
For data capabilities and usage examples, see the [Official Plugins documentation](./datasource.md).
167-
168198
## Security Model
169199

170200
Plugins have a limited loading scope. The following operations do not occur during installation or session startup:
@@ -176,6 +206,5 @@ Plugins have a limited loading scope. The following operations do not occur duri
176206

177207
## Next steps
178208

179-
- [Kimi Datasource](./datasource.md) — Official data plugin: installation and usage for financial market data, corporate records, and academic literature
180209
- [Agent Skills](./skills.md) — File format and frontmatter field reference for Skills
181210
- [MCP](./mcp.md) — Full schema and permission configuration for plugin MCP servers

docs/en/guides/getting-started.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ The CLI is written in TypeScript, distributed via npm, and runs on Node.js.
1616

1717
Two installation options are available: the official install script (recommended, no pre-installed Node.js required) and a global npm install.
1818

19+
::: tip Before you install
20+
Kimi Code CLI is a fully interactive TUI application. For the best visual experience, run it in a terminal with true-color and ligature support, such as [Kitty](https://sw.kovidgoyal.net/kitty/) or [Ghostty](https://ghostty.org/).
21+
:::
22+
1923
### Install script (recommended)
2024

2125
- **macOS / Linux**:

0 commit comments

Comments
 (0)