dsh-deeptutor 0.1.0 → 0.1.2

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.
Files changed (3) hide show
  1. package/README.md +39 -4
  2. package/README.zh.md +25 -3
  3. package/package.json +6 -3
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # dsh-deeptutor
2
2
 
3
+ **English** | [简体中文](README.zh.md)
4
+
3
5
  DeepTutor bridge **bundle** for **DeepSeek Harness (dsh)**, migrated from the
4
6
  pi coding-agent extension (`TecFancy/pi-extensions`, `extensions/deeptutor` +
5
7
  `skills/deeptutor`).
@@ -13,21 +15,40 @@ Registers three model-facing tools that drive the
13
15
  | `deeptutor_kb` | List / search / info the user's personal knowledge bases (RAG) |
14
16
  | `deeptutor_note` | Archive Markdown learning notes to a server notebook |
15
17
 
18
+ The seven capabilities above are the fixed enum accepted by `deeptutor_run`.
19
+ The underlying DeepTutor CLI may expose more — enumerate the full command set
20
+ with `deeptutor --help` / `deeptutor <cmd> --help`. The `deeptutor` skill
21
+ instructs the agent to discover commands this way and, when the tool's enum
22
+ doesn't cover a capability, to drive the CLI directly (local binary or over
23
+ SSH).
24
+
16
25
  Deployment auto-detects local vs. remote: local `serve` (or local CLI) on this
17
26
  machine, or a server reached through an auto-started SSH tunnel (with SSH CLI
18
27
  fallback).
19
28
 
20
29
  ## Install into a profile (bundle)
21
30
 
22
- Publish it (or point `dependencies` at a registry you control), then either:
31
+ The package is published to npm as `dsh-deeptutor`. Install it with a single
32
+ command — `dsh plugin add` forwards to pnpm and then reconciles the profile's
33
+ `dsh.profile.bundles` against the installed state, so a `dsh.bundle`-declaring
34
+ package like this one is registered automatically (verified on dsh CLI
35
+ 0.1.0-rc.6):
23
36
 
24
37
  ```sh
25
- # one-shot: install the package into the profile and add it to the bundle list
26
38
  dsh plugin --profile web add dsh-deeptutor
27
39
  ```
28
40
 
29
- or add it manually to the profile manifest
30
- (`~/.dsh/profiles/<name>/package.json`):
41
+ Verify the bundle is mounted, then restart dsh (the bundle list is resolved
42
+ at boot):
43
+
44
+ ```sh
45
+ dsh --profile web --dump-config | grep dsh-deeptutor
46
+ ```
47
+
48
+ If your dsh CLI does not auto-register the bundle (older versions, or you
49
+ installed the dependency manually), add it to the profile manifest
50
+ (`~/.dsh/profiles/<name>/package.json`) and run `dsh plugin --profile web
51
+ install`:
31
52
 
32
53
  ```json
33
54
  {
@@ -38,6 +59,20 @@ or add it manually to the profile manifest
38
59
  }
39
60
  ```
40
61
 
62
+ Alternatively, keep the manifest untouched and mount the bundle through a user
63
+ patch layer (the npm package still has to be installed first):
64
+
65
+ ```yaml
66
+ # overlay.yml — insert the bundle row via a user patch layer
67
+ - insert:
68
+ - id: dsh-deeptutor
69
+ name: 'dsh-deeptutor'
70
+ ```
71
+
72
+ ```sh
73
+ dsh web --patch ./overlay.yml
74
+ ```
75
+
41
76
  The bundle manifest (`dsh.bundle.patch → cordis.patch.yml`) inserts the plugin
42
77
  row; later patch layers can override or disable it by id.
43
78
 
package/README.zh.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # dsh-deeptutor
2
2
 
3
+ [English](README.md) | **简体中文**
4
+
3
5
  面向 **DeepSeek Harness (dsh)** 的 DeepTutor 桥接 **bundle**,从 pi 编码 agent 扩展迁移而来(`TecFancy/pi-extensions`,`extensions/deeptutor` + `skills/deeptutor`)。
4
6
 
5
7
  注册三个模型可见工具,驱动 [HKUDS/DeepTutor](https://github.com/HKUDS/DeepTutor) 辅导服务:
@@ -10,18 +12,25 @@
10
12
  | `deeptutor_kb` | 列出 / 搜索 / 查看个人知识库(RAG)信息 |
11
13
  | `deeptutor_note` | 将 Markdown 学习笔记归档到服务端 notebook |
12
14
 
15
+ 上表 7 个 capability 是 `deeptutor_run` 工具接受的固定枚举。底层 DeepTutor CLI 可能支持更多命令——用 `deeptutor --help` / `deeptutor <cmd> --help` 可枚举完整命令集。`deeptutor` skill 会指示 agent 用这种方式动态发现命令;当工具的枚举未覆盖某能力时,agent 可直接调用 CLI(本地二进制或经 SSH)来驱动。
16
+
13
17
  部署模式自动适配:本机本地 `serve`(或本地 CLI),或通过自动建立的 SSH 隧道访问服务器(含 SSH CLI 回退)。
14
18
 
15
19
  ## 安装到 profile(bundle 方式)
16
20
 
17
- 发布后(或指向你控制的 registry),任选其一:
21
+ 包已发布到 npm(`dsh-deeptutor`)。一条命令即可安装:`dsh plugin add` 会转发给 pnpm 安装依赖,并把 profile 的 `dsh.profile.bundles` 与已安装状态对账,因此声明了 `dsh.bundle` 的包(如本插件)会被自动登记(已在 dsh CLI 0.1.0-rc.6 上验证):
18
22
 
19
23
  ```sh
20
- # 一键:将包安装进 profile 并加入 bundle 列表
21
24
  dsh plugin --profile web add dsh-deeptutor
22
25
  ```
23
26
 
24
- 或手动编辑 profile 清单(`~/.dsh/profiles/<name>/package.json`):
27
+ 验证挂载,然后重启 dsh(bundle 列表在启动时解析):
28
+
29
+ ```sh
30
+ dsh --profile web --dump-config | grep dsh-deeptutor
31
+ ```
32
+
33
+ 如果你的 dsh CLI 不会自动登记 bundle(旧版本,或手动安装依赖),请在 profile 清单(`~/.dsh/profiles/<name>/package.json`)中手动加入,再运行 `dsh plugin --profile web install`:
25
34
 
26
35
  ```json
27
36
  {
@@ -32,6 +41,19 @@ dsh plugin --profile web add dsh-deeptutor
32
41
  }
33
42
  ```
34
43
 
44
+ 也可以不动清单,改用用户 patch 层挂载 bundle(仍需先安装 npm 包):
45
+
46
+ ```yaml
47
+ # overlay.yml —— 通过用户 patch 层插入 bundle 行
48
+ - insert:
49
+ - id: dsh-deeptutor
50
+ name: 'dsh-deeptutor'
51
+ ```
52
+
53
+ ```sh
54
+ dsh web --patch ./overlay.yml
55
+ ```
56
+
35
57
  bundle 清单(`dsh.bundle.patch → cordis.patch.yml`)负责插入插件行;上层 patch 层可按 id 覆盖或禁用。
36
58
 
37
59
  ## 源码开发(无需发布)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dsh-deeptutor",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "DeepTutor bridge bundle for DeepSeek Harness: learning capabilities, knowledge bases, and note archiving (HTTP/WS first, CLI fallback; auto-adapts local/remote deployment).",
5
5
  "keywords": [
6
6
  "dsh",
@@ -29,7 +29,8 @@
29
29
  "src",
30
30
  "scripts",
31
31
  "cordis.patch.yml",
32
- "README.md"
32
+ "README.md",
33
+ "README.zh.md"
33
34
  ],
34
35
  "dsh": {
35
36
  "bundle": {
@@ -42,11 +43,13 @@
42
43
  "prepack": "npm run build && npm run typecheck",
43
44
  "pack:check": "npm pack --dry-run"
44
45
  },
45
- "dependencies": {
46
+ "peerDependencies": {
46
47
  "@deepseek-ai/cordis": "^4.0.1",
47
48
  "@deepseek-ai/dsh-tools": "^0.1.0-rc.6"
48
49
  },
49
50
  "devDependencies": {
51
+ "@deepseek-ai/cordis": "^4.0.1",
52
+ "@deepseek-ai/dsh-tools": "^0.1.0-rc.6",
50
53
  "@types/node": "^24.0.0",
51
54
  "typescript": "^5.9.3"
52
55
  }