opencode-gbk-tools 0.1.0 → 0.1.1

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 CHANGED
@@ -11,6 +11,25 @@
11
11
 
12
12
  ## 安装
13
13
 
14
+ 推荐方式:直接作为 OpenCode npm plugin 加载工具。
15
+
16
+ `opencode.json`:
17
+
18
+ ```json
19
+ {
20
+ "$schema": "https://opencode.ai/config.json",
21
+ "plugin": ["opencode-gbk-tools"]
22
+ }
23
+ ```
24
+
25
+ 这样会直接注册:
26
+
27
+ - `gbk_read`
28
+ - `gbk_write`
29
+ - `gbk_edit`
30
+
31
+ 如果你还需要预置 `gbk-engine` agent,请继续使用下面的 CLI 安装方式把 agent 文件写入本地配置目录。
32
+
14
33
  一次性使用:
15
34
 
16
35
  ```bash
@@ -53,6 +72,12 @@ opencode-gbk doctor --project
53
72
 
54
73
  安装后会生成 `gbk-engine`。
55
74
 
75
+ 说明:
76
+
77
+ - npm `plugin` 方式负责注册 `gbk_read`、`gbk_write`、`gbk_edit`
78
+ - `gbk-engine` 仍通过 CLI 安装到 `.opencode/agents/` 或 `~/.config/opencode/agents/`
79
+ - 如果你只需要工具,不需要 agent,只配置 `plugin` 即可
80
+
56
81
  它的目标是:
57
82
 
58
83
  - 文件内容读取必须走 `gbk_read`