opencode-gbk-tools 0.1.1 → 0.1.3

package/README.md

@@ -13,6 +13,24 @@
 
 推荐方式：直接作为 OpenCode npm plugin 加载工具。
 
+最方便的一键接入：
+
+```bash
+npx opencode-gbk-tools setup --project
+```
+
+这条命令会自动：
+
+- 在当前项目写入或更新 `opencode.json`
+- 自动加入 `plugin: ["opencode-gbk-tools"]`
+- 安装 `.opencode/agents/gbk-engine.md`
+
+如果你想装到用户全局 OpenCode 配置：
+
+```bash
+npx opencode-gbk-tools setup
+```
+
 `opencode.json`:
 
 ```json
@@ -30,6 +48,8 @@
 
 如果你还需要预置 `gbk-engine` agent，请继续使用下面的 CLI 安装方式把 agent 文件写入本地配置目录。
 
+推荐优先使用 `setup`，`install` 更适合手动拆分安装流程。
+
 一次性使用：
 
 ```bash
@@ -41,6 +61,7 @@ npx opencode-gbk-tools install
 ```bash
 npm install -g opencode-gbk-tools
 opencode-gbk install
+opencode-gbk setup
 ```
 
 安装到当前项目：
@@ -57,6 +78,9 @@ opencode-gbk install --project
 ## CLI
 
 ```bash
+opencode-gbk setup
+opencode-gbk setup --project
+
 opencode-gbk install
 opencode-gbk install --project
 opencode-gbk install --force
@@ -75,6 +99,7 @@ opencode-gbk doctor --project
 说明：
 
 - npm `plugin` 方式负责注册 `gbk_read`、`gbk_write`、`gbk_edit`
+- `setup` 会自动写入 `plugin` 配置并安装 `gbk-engine`
 - `gbk-engine` 仍通过 CLI 安装到 `.opencode/agents/` 或 `~/.config/opencode/agents/`
 - 如果你只需要工具，不需要 agent，只配置 `plugin` 即可
 
@@ -93,6 +118,14 @@ opencode-gbk doctor --project
 - `edit: deny` 在 OpenCode 中会一起限制内置 `write`、`patch`、`multiedit`
 - 对无法映射的字符沿用 `iconv-lite` 默认替代行为
 
+## 大文件建议
+
+- `gbk_read` 支持 `tail` 预览最后 N 行
+- `gbk_read` 返回 `fileSize`、`newlineStyle`、`streamed`、`truncated`
+- `gbk_edit` 支持 `startLine/endLine`
+- `gbk_edit` 支持 `startAnchor/endAnchor`
+- 大文件会自动走更省内存的流式路径
+
 ## 发布
 
 ```bash

package/dist/agents/gbk-engine.md

@@ -18,6 +18,8 @@ permission:
 - 读取文件时优先使用 `gbk_read`
 - 创建或覆盖文件时优先使用 `gbk_write`
 - 修改已有文件时优先使用 `gbk_edit`
+- 大文件读取优先使用 `gbk_read` 的分页或 `tail` 能力，避免一次读取过多内容
+- 修改时优先缩小编辑范围：能用 `startLine/endLine` 或 `startAnchor/endAnchor` 就不要全文替换
 - 文件发现可使用 `glob`，但文件内容读取必须使用 `gbk_read`
 - 禁止依赖内置 `read`、`grep`、`write`、`edit`、`patch`
 - `edit: deny` 同时覆盖内置 `write`、`patch`、`multiedit`

package/dist/cli/index.js

@@ -1,5 +1,5 @@
 // src/cli/index.ts
-import path6 from "path";
+import path7 from "path";
 import { fileURLToPath } from "url";
 
 // src/cli/install.ts
@@ -60,9 +60,11 @@ function resolveTargetBase(target, cwd) {
 // src/cli/install.ts
 async function installCommand(args) {
   const targetBase = resolveTargetBase(args.target, args.cwd);
+  const allowedArtifacts = new Set(args.artifacts ?? ["tool", "agent"]);
   const releaseManifest = JSON.parse(await fs3.readFile(path3.join(args.packageRoot, "dist", "release-manifest.json"), "utf8"));
+  const selectedArtifacts = releaseManifest.artifacts.filter((artifact) => allowedArtifacts.has(artifact.kind));
   const existingManifest = await loadInstalledManifest(targetBase);
-  for (const artifact of releaseManifest.artifacts) {
+  for (const artifact of selectedArtifacts) {
     const targetPath = path3.join(targetBase, artifact.relativePath);
     if (await pathExists(targetPath) && !existingManifest && !args.force) {
       throw new Error(`\u68C0\u6D4B\u5230\u672A\u53D7\u7BA1\u6587\u4EF6\u51B2\u7A81: ${targetPath}`);
@@ -78,13 +80,13 @@ async function installCommand(args) {
     targetType: args.target,
     targetBase,
     installedAt: (/* @__PURE__ */ new Date()).toISOString(),
-    files: releaseManifest.artifacts.map((artifact) => ({
+    files: selectedArtifacts.map((artifact) => ({
       ...artifact,
       installedByVersion: releaseManifest.packageVersion
     }))
   };
   await writeInstalledManifest(targetBase, installedManifest);
-  return { targetBase };
+  return { targetBase, installedFiles: selectedArtifacts.length };
 }
 
 // src/cli/uninstall.ts
@@ -131,13 +133,68 @@ async function doctorCommand(args) {
   return { ok: issues.length === 0, issues };
 }
 
+// src/cli/setup.ts
+import fs6 from "fs/promises";
+import path6 from "path";
+import os2 from "os";
+import { applyEdits, modify, parse } from "jsonc-parser";
+async function resolveConfigFile(baseDir) {
+  const jsoncPath = path6.join(baseDir, "opencode.jsonc");
+  const jsonPath = path6.join(baseDir, "opencode.json");
+  try {
+    await fs6.access(jsoncPath);
+    return jsoncPath;
+  } catch {
+    try {
+      await fs6.access(jsonPath);
+      return jsonPath;
+    } catch {
+      return jsonPath;
+    }
+  }
+}
+async function ensurePluginConfigured(configPath, pluginName) {
+  let content = '{\n  "$schema": "https://opencode.ai/config.json"\n}\n';
+  try {
+    content = await fs6.readFile(configPath, "utf8");
+  } catch {
+  }
+  const parsed = parse(content);
+  const plugins = parsed?.plugin ?? [];
+  if (plugins.includes(pluginName)) {
+    return configPath;
+  }
+  const edits = modify(content, ["plugin"], [...plugins, pluginName], {
+    formattingOptions: {
+      insertSpaces: true,
+      tabSize: 2,
+      eol: "\n"
+    }
+  });
+  const updated = applyEdits(content, edits);
+  await fs6.writeFile(configPath, updated, "utf8");
+  return configPath;
+}
+async function setupCommand(args) {
+  const pluginName = "opencode-gbk-tools";
+  const configBase = args.target === "project" ? args.cwd : path6.join(os2.homedir(), ".config", "opencode");
+  await fs6.mkdir(configBase, { recursive: true });
+  const configPath = await resolveConfigFile(configBase);
+  await ensurePluginConfigured(configPath, pluginName);
+  const installResult = await installCommand({ ...args, force: true, artifacts: ["agent"] });
+  return {
+    configPath,
+    targetBase: installResult.targetBase
+  };
+}
+
 // src/cli/index.ts
 function resolvePackageRoot(env = process.env, moduleUrl = import.meta.url) {
   if (env.OPENCODE_GBK_PACKAGE_ROOT) {
     return env.OPENCODE_GBK_PACKAGE_ROOT;
   }
   const modulePath = fileURLToPath(moduleUrl);
-  return path6.resolve(path6.dirname(modulePath), "..", "..");
+  return path7.resolve(path7.dirname(modulePath), "..", "..");
 }
 async function main(argv, env = process.env) {
   const [command, ...rest] = argv;
@@ -148,6 +205,9 @@ async function main(argv, env = process.env) {
   if (command === "install") {
     return await installCommand({ packageRoot, target, cwd, force });
   }
+  if (command === "setup") {
+    return await setupCommand({ packageRoot, target, cwd });
+  }
   if (command === "uninstall") {
     return await uninstallCommand({ target, cwd });
   }