@klarkxy/dsh-dev-index 0.2.1 → 0.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -66
- package/README.zh-CN.md +15 -66
- package/dsh.plugin.json +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,52 +1,29 @@
|
|
|
1
1
|
# DSH Docs
|
|
2
2
|
|
|
3
3
|
<!-- release-state-note -->
|
|
4
|
-
The [repository registry](../../README.md#plugin-lifecycle) tracks Draft → Testing → Published, moving forward only. Fixes, testing and version updates keep published packages Published; each update still passes release checks. First publication explicitly selects Testing packages and records Published only after npm archive verification. See the [release guide](../../RELEASING.md).
|
|
5
4
|
|
|
6
|
-
[简体中文](README.zh-CN.md)
|
|
5
|
+
[简体中文](README.zh-CN.md)
|
|
7
6
|
|
|
8
|
-
|
|
7
|
+
Read the official DeepSeek Harness documentation without leaving DSH, and give Creator mode tools to look up the docs and check plugins before installing them.
|
|
9
8
|
|
|
10
|
-
|
|
9
|
+
## Install
|
|
11
10
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
The plugin no longer ships or depends on a mirrored index. The [klarkxy Pages site](https://klarkxy.github.io/dsh-plugins/) is now a catalog of klarkxy's DSH plugins; its old index URLs redirect to the official site.
|
|
17
|
-
|
|
18
|
-
## Read in the Plugins page
|
|
19
|
-
|
|
20
|
-
In DSH Web, open **Plugins → DSH Docs**. The page shows the official GitHub Pages documentation in a reader panel: it opens the Chinese or English home page in the DSH interface language, offers a **中文 / English** switch, and links to the site in a separate tab. **Documentation home** reloads the home page of the language you are reading. If the embedded page does not load, the panel offers **Open in browser** and **Retry**.
|
|
21
|
-
|
|
22
|
-
## Creator mode guidance
|
|
23
|
-
|
|
24
|
-
The host half adds one system-prompt section when the session uses the `cordis` preset (Creator mode). It tells the agent to use `dsh_docs_search` and `dsh_docs_fetch` before choosing APIs, and `dsh_plugins_search` and `dsh_plugins_fetch` before installing or depending on a plugin. Other presets receive no extra prompt. All four read-only tools are registered with the host tool registry and remain subject to its tool policies. The plugin registers no skill.
|
|
25
|
-
|
|
26
|
-
- `dsh_docs_search({ query: "plugin", language: "en" })` searches the live official `llms.txt` directory: titles, categories and paths. This is a directory search, not full-text search; an empty result does not establish that a topic is absent from the document bodies, so try broader Chinese or English keywords.
|
|
27
|
-
- `dsh_docs_fetch({ id: "en/develop/basic/tool.md" })` reads a document ID returned by search. Results include the source URL, fetch time, content revision and `nextOffset`. Continue with that offset and the same `revision`; if the document changes, restart from offset zero. The default page size is 12,000 characters, at most 16,000.
|
|
28
|
-
- `dsh_plugins_search({ query: "memory" })` finds candidate plugins. The default `catalog` source searches the curated klarkxy Chinese/English plugin catalog; `source: "npm"` searches npm's `dsh-plugin` keyword more broadly. Neither source is exhaustive, and a hit is a candidate rather than verified compatibility.
|
|
29
|
-
- `dsh_plugins_fetch({ package: "@klarkxy/dsh-current-title", version: "latest" })` reads npm registry metadata for an exact package name: dist-tags, published versions in publication-time order, and the selected version's bundle declaration, DSH/Node engine ranges, dependencies and deprecation. `version` accepts an exact release or a dist-tag; ranges are rejected.
|
|
30
|
-
|
|
31
|
-
The plugin-registry tools are read-only metadata lookups: nothing is downloaded, installed or executed, and a declared engines range is not runtime compatibility proof. GitHub-installed plugins have no registry metadata; install those directly with the official plugin manager as `github:owner/repo#commit`, and review their `package.json` yourself.
|
|
32
|
-
|
|
33
|
-
## Boundaries and limits
|
|
34
|
-
|
|
35
|
-
Document requests run in the plugin host through its existing HTTP proxy policy, without shell commands or `web_fetch`. Only Markdown entries from the fixed official documentation index can be fetched: redirects and arbitrary URLs are rejected, and TLS verification stays enabled. A request times out after 20 seconds, and one document is capped at 2 MiB.
|
|
36
|
-
|
|
37
|
-
A five-minute memory cache holds at most 32 pages / 8 MiB. Pass `refresh: true` to bypass it. Expired data must refresh successfully: failed requests are reported, never silently replaced by an old snapshot. Disabling the plugin cancels its requests and clears the cache. No bundled documentation snapshot, persistent index or separate MCP server is needed.
|
|
11
|
+
```sh
|
|
12
|
+
dsh plugin --profile web add @klarkxy/dsh-dev-index
|
|
13
|
+
```
|
|
38
14
|
|
|
39
|
-
|
|
15
|
+
Replace `web` with your profile name and restart the profile.
|
|
40
16
|
|
|
41
|
-
|
|
17
|
+
## Use
|
|
42
18
|
|
|
43
|
-
|
|
19
|
+
- **Plugins → DSH Docs** shows the [official documentation site](https://deepseek-harness.github.io/deepseek-harness/) inside DSH, with a Chinese / English switch.
|
|
20
|
+
- In Creator mode the agent gets four read-only tools: `dsh_docs_search` and `dsh_docs_fetch` to find and read official docs, and `dsh_plugins_search` and `dsh_plugins_fetch` to check a plugin's npm information before installing it. Creator mode is also reminded to verify runtime interfaces with `cordis_inspect_list` and `cordis_inspect_query`.
|
|
44
21
|
|
|
45
|
-
|
|
46
|
-
dsh plugin --profile web add @klarkxy/dsh-dev-index
|
|
47
|
-
```
|
|
22
|
+
## Limits
|
|
48
23
|
|
|
49
|
-
The
|
|
24
|
+
- The tools only read; they never install anything. Installing stays with the DSH plugin manager.
|
|
25
|
+
- The website follows the latest DSH release, which may differ from the version you run.
|
|
26
|
+
- npm metadata is not proof that a plugin works with your DSH.
|
|
50
27
|
|
|
51
28
|
## Install from GitHub
|
|
52
29
|
|
|
@@ -54,41 +31,13 @@ The published npm package includes the built `lib/` files.
|
|
|
54
31
|
dsh plugin --profile web add "github:klarkxy/dsh-plugins#path:/plugins/dsh-dev-index"
|
|
55
32
|
```
|
|
56
33
|
|
|
57
|
-
A
|
|
34
|
+
A GitHub install builds the plugin locally, so pnpm first asks you to allow it. Add this to `$DSH_HOME/profiles/web/pnpm-workspace.yaml`, then run the command again:
|
|
58
35
|
|
|
59
36
|
```yaml
|
|
60
37
|
allowBuilds:
|
|
61
38
|
'@klarkxy/dsh-dev-index': true
|
|
62
39
|
```
|
|
63
40
|
|
|
64
|
-
Run the add command again: that allowance executes this package's build on your machine. Pin a commit when the plugin source must not move.
|
|
65
|
-
|
|
66
|
-
Peer ranges on `@deepseek-ai/dsh-system-prompt` and `@deepseek-ai/dsh-agent-preset-registry` are checked against the running `dsh` version. This package requires DSH `>=0.1.7-rc.2`, and the loader does not enforce `engines.dsh`.
|
|
67
|
-
|
|
68
|
-
## Install from this checkout
|
|
69
|
-
|
|
70
|
-
```bash
|
|
71
|
-
pnpm install
|
|
72
|
-
pnpm --filter @klarkxy/dsh-dev-index build
|
|
73
|
-
dsh plugin --profile web add ./plugins/dsh-dev-index
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
Restart the profile, or let HMR apply the new bundle. Then:
|
|
77
|
-
|
|
78
|
-
```bash
|
|
79
|
-
dsh --profile web --dump-config
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
The composition should contain a `dsh-dev-index` row. Start a new Creator-mode session to pick up the documentation guidance automatically.
|
|
83
|
-
|
|
84
|
-
There is no configuration: the patch inserts the plugin and sets no keys.
|
|
85
|
-
|
|
86
41
|
## License
|
|
87
42
|
|
|
88
43
|
[SATA License 2.1](LICENSE)
|
|
89
|
-
|
|
90
|
-
## Uninstall
|
|
91
|
-
|
|
92
|
-
```bash
|
|
93
|
-
dsh plugin --profile web remove @klarkxy/dsh-dev-index
|
|
94
|
-
```
|
package/README.zh-CN.md
CHANGED
|
@@ -1,52 +1,29 @@
|
|
|
1
1
|
# DSH 文档
|
|
2
2
|
|
|
3
3
|
<!-- release-state-note -->
|
|
4
|
-
插件生命周期见[仓库状态清单](../../README.zh-CN.md#插件生命周期)：草稿 → 测试中 → 已发布，只向前推进。已发布插件的修复、测试和升版保持已发布；每次更新仍须通过发布检查。首次发布须明确选择测试中的包，并在 npm 归档验证成功后登记。详见[发布规则](../../RELEASING.zh-CN.md)。
|
|
5
4
|
|
|
6
|
-
[
|
|
5
|
+
[English](README.md)
|
|
7
6
|
|
|
8
|
-
|
|
7
|
+
不离开 DSH 就能阅读 DeepSeek Harness 官方文档；创造模式还会获得查文档、在安装前核对插件信息的工具。
|
|
9
8
|
|
|
10
|
-
|
|
9
|
+
## 安装
|
|
11
10
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
插件不再附带或依赖镜像索引。[klarkxy Pages 站点](https://klarkxy.github.io/dsh-plugins/) 现在是 klarkxy 的 DSH 插件目录，旧索引地址会跳转到官方站点。
|
|
17
|
-
|
|
18
|
-
## 在插件页阅读
|
|
19
|
-
|
|
20
|
-
在 DSH Web 打开 **插件 → DSH 文档**，页面会在内嵌的阅读面板里显示官方 GitHub Pages 文档：默认按 DSH 界面语言打开中文或英文首页，可用 **中文 / English** 切换语言，**返回文档首页** 重新载入当前语言首页，工具栏还可以在独立标签页打开该站点。内嵌页面没有显示时，面板会给出“在浏览器中打开”和“重试”。
|
|
21
|
-
|
|
22
|
-
## 创造模式指引
|
|
23
|
-
|
|
24
|
-
宿主插件在会话使用 `cordis` 预设（创造模式）时加入一段系统提示，要求智能体选择 API 前先调用 `dsh_docs_search` 和 `dsh_docs_fetch` 阅读官方文档，安装或依赖某个插件前先调用 `dsh_plugins_search` 和 `dsh_plugins_fetch` 核实元数据。其他预设不注入额外提示。四个只读工具都注册在宿主工具表中，仍受宿主工具策略约束。本插件不注册 Skill。
|
|
25
|
-
|
|
26
|
-
- `dsh_docs_search({ query: "插件", language: "zh" })` 在线读取官方 `llms.txt`，搜索标题、分类和路径。这是目录搜索，不是全文搜索；没有命中不代表正文不含相关内容，可以改用更宽泛的中文或英文关键词。
|
|
27
|
-
- `dsh_docs_fetch({ id: "develop/basic/tool.md" })` 读取搜索结果中的文档 ID。结果包含来源、获取时间、内容修订值和 `nextOffset`。长文用该偏移量和相同的 `revision` 继续读取；正文更新时需要从头重读。默认每次返回 12,000 字符，上限 16,000。
|
|
28
|
-
- `dsh_plugins_search({ query: "记忆" })` 查找候选插件。默认 `catalog` 数据源搜索 klarkxy 维护的中英文插件目录；`source: "npm"` 用 npm 的 `dsh-plugin` 关键词做更宽的发现。两个源都不是全量目录，命中结果只是候选，不代表兼容性已验证。
|
|
29
|
-
- `dsh_plugins_fetch({ package: "@klarkxy/dsh-current-title", version: "latest" })` 按确切包名读取 npm 注册表元数据：dist-tags、按发布时间排序的版本列表，以及选定版本的组合包声明、DSH／Node 版本要求、依赖和弃用说明。`version` 可填精确版本或标签，不接受范围。
|
|
30
|
-
|
|
31
|
-
插件注册表工具是只读元数据查询：不下载、不安装、不执行任何代码，声明的 engines 范围也不是运行时兼容性证明。从 GitHub 安装的插件没有注册表元数据，直接用官方插件管理器以 `github:owner/repo#commit` 安装，并自行审阅其 `package.json`。
|
|
32
|
-
|
|
33
|
-
## 边界与限制
|
|
34
|
-
|
|
35
|
-
文档请求由插件宿主执行，沿用 DSH 已有的 HTTP 代理策略，不执行命令，也不调用 `web_fetch`。只读取固定官方索引列出的 Markdown：拒绝任意 URL 和跳转，保留 TLS 证书校验。单次请求超时为 20 秒，单篇文档上限为 2 MiB。
|
|
36
|
-
|
|
37
|
-
内存缓存有效期为五分钟，最多保存 32 页、8 MiB。传入 `refresh: true` 可立即刷新。过期数据必须成功刷新后才能使用；请求失败会报告错误，不会静默返回旧副本。停用插件会取消请求并清空缓存。无需随包分发文档快照、维护持久索引或部署 MCP 服务。
|
|
11
|
+
```sh
|
|
12
|
+
dsh plugin --profile web add @klarkxy/dsh-dev-index
|
|
13
|
+
```
|
|
38
14
|
|
|
39
|
-
|
|
15
|
+
把 `web` 换成你的 profile 名，安装后重启 profile。
|
|
40
16
|
|
|
41
|
-
|
|
17
|
+
## 使用
|
|
42
18
|
|
|
43
|
-
|
|
19
|
+
- 「插件 → DSH 文档」会在 DSH 内显示[官方文档站](https://deepseek-harness.github.io/deepseek-harness/)，可切换中文 / English。
|
|
20
|
+
- 创造模式下，智能体获得四个只读工具：`dsh_docs_search` 和 `dsh_docs_fetch` 用于查找和阅读官方文档，`dsh_plugins_search` 和 `dsh_plugins_fetch` 用于在安装前查看插件的 npm 信息。创造模式还会被提醒用 `cordis_inspect_list` 和 `cordis_inspect_query` 核对运行时接口。
|
|
44
21
|
|
|
45
|
-
|
|
46
|
-
dsh plugin --profile web add @klarkxy/dsh-dev-index
|
|
47
|
-
```
|
|
22
|
+
## 限制
|
|
48
23
|
|
|
49
|
-
|
|
24
|
+
- 这些工具只读，不会安装任何东西；安装仍由 DSH 插件管理器负责。
|
|
25
|
+
- 官网对应最新发布的 DSH，可能与你正在使用的版本不同。
|
|
26
|
+
- npm 元数据不能证明插件与你的 DSH 兼容。
|
|
50
27
|
|
|
51
28
|
## 从 GitHub 安装
|
|
52
29
|
|
|
@@ -54,41 +31,13 @@ npm 包包含已构建的 `lib/`。
|
|
|
54
31
|
dsh plugin --profile web add "github:klarkxy/dsh-plugins#path:/plugins/dsh-dev-index"
|
|
55
32
|
```
|
|
56
33
|
|
|
57
|
-
|
|
34
|
+
从 GitHub 安装会在本机构建插件，pnpm 会先要求你允许。把下面内容加入 `$DSH_HOME/profiles/web/pnpm-workspace.yaml` 后再执行一次安装命令：
|
|
58
35
|
|
|
59
36
|
```yaml
|
|
60
37
|
allowBuilds:
|
|
61
38
|
'@klarkxy/dsh-dev-index': true
|
|
62
39
|
```
|
|
63
40
|
|
|
64
|
-
然后再执行一次 add：该许可会在本机执行这个包的构建。需要固定插件来源时请钉住 commit。
|
|
65
|
-
|
|
66
|
-
`@deepseek-ai/dsh-system-prompt` 和 `@deepseek-ai/dsh-agent-preset-registry` 的 peer 范围会对照正在运行的 `dsh` 版本检查。本包要求 DSH `>=0.1.7-rc.2`；加载器不强制 `engines.dsh`。
|
|
67
|
-
|
|
68
|
-
## 从本仓库安装
|
|
69
|
-
|
|
70
|
-
```bash
|
|
71
|
-
pnpm install
|
|
72
|
-
pnpm --filter @klarkxy/dsh-dev-index build
|
|
73
|
-
dsh plugin --profile web add ./plugins/dsh-dev-index
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
安装后重启该 profile，或让 HMR 应用新 bundle。然后：
|
|
77
|
-
|
|
78
|
-
```bash
|
|
79
|
-
dsh --profile web --dump-config
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
组合结果里应有 `dsh-dev-index` 这一行。新建创造模式会话即可自动收到文档指引。
|
|
83
|
-
|
|
84
|
-
没有配置项：补丁只插入插件，不设置任何键。
|
|
85
|
-
|
|
86
41
|
## 许可证
|
|
87
42
|
|
|
88
43
|
[SATA License 2.1](LICENSE)
|
|
89
|
-
|
|
90
|
-
## 卸载
|
|
91
|
-
|
|
92
|
-
```bash
|
|
93
|
-
dsh plugin --profile web remove @klarkxy/dsh-dev-index
|
|
94
|
-
```
|
package/dsh.plugin.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@klarkxy/dsh-dev-index",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.3",
|
|
4
4
|
"description": "DSH Docs: read the official DSH documentation in the Plugins page; Creator mode searches docs and checks plugin npm metadata with native tools.",
|
|
5
5
|
"icon": "./icon.svg",
|
|
6
6
|
"keywords": [
|
|
@@ -80,7 +80,7 @@
|
|
|
80
80
|
"@deepseek-ai/dsh-tools": ">=0.2.0-rc.2"
|
|
81
81
|
},
|
|
82
82
|
"dependencies": {
|
|
83
|
-
"@klarkxy/dsh-plugin-kit": "0.3.
|
|
83
|
+
"@klarkxy/dsh-plugin-kit": "0.3.2"
|
|
84
84
|
},
|
|
85
85
|
"peerDependenciesMeta": {
|
|
86
86
|
"@deepseek-ai/dsh-agent-preset-registry": {
|
|
@@ -107,6 +107,6 @@
|
|
|
107
107
|
"registry": "https://registry.npmjs.org/"
|
|
108
108
|
},
|
|
109
109
|
"dshRelease": {
|
|
110
|
-
"contentHash": "
|
|
110
|
+
"contentHash": "19c9c3caac1a5d32bfc7a6146f3da5e1f8b641ac35a9d7ac3d71b728e9e4e0ec"
|
|
111
111
|
}
|
|
112
112
|
}
|