@symerian/symi 3.0.20 → 3.0.22

package/docs/zh-CN/tools/plugin.md

@@ -1,639 +0,0 @@
----
-read_when:
-  - 添加或修改插件/扩展
-  - 记录插件安装或加载规则
-summary: Symi 插件/扩展：发现、配置和安全
-title: 插件
-x-i18n:
-  generated_at: "2026-02-03T07:55:25Z"
-  model: claude-opus-4-5
-  provider: pi
-  source_hash: b36ca6b90ca03eaae25c00f9b12f2717fcd17ac540ba616ee03b398b234c2308
-  source_path: tools/plugin.md
-  workflow: 15
----
-
-# 插件（扩展）
-
-## 快速开始（插件新手？）
-
-插件只是一个**小型代码模块**，用额外功能（命令、工具和 Gateway 网关 RPC）扩展 Symi。
-
-大多数时候，当你想要一个尚未内置到核心 Symi 的功能（或你想将可选功能排除在主安装之外）时，你会使用插件。
-
-快速路径：
-
-1. 查看已加载的内容：
-
-```bash
-symi plugins list
-```
-
-2. 安装官方插件（例如：Voice Call）：
-
-```bash
-symi plugins install @symi/voice-call
-```
-
-3. 重启 Gateway 网关，然后在 `plugins.entries.<id>.config` 下配置。
-
-参见 [Voice Call](/plugins/voice-call) 了解具体的插件示例。
-
-## 可用插件（官方）
-
-- 从 2026.1.15 起 Microsoft Teams 仅作为插件提供；如果使用 Teams，请安装 `@symi/msteams`。
-- Memory (Core) — 捆绑的记忆搜索插件（通过 `plugins.slots.memory` 默认启用）
-- Memory (LanceDB) — 捆绑的长期记忆插件（自动召回/捕获；设置 `plugins.slots.memory = "memory-lancedb"`）
-- [Voice Call](/plugins/voice-call) — `@symi/voice-call`
-- [Zalo Personal](/plugins/zalouser) — `@symi/zalouser`
-- [Matrix](/channels/matrix) — `@symi/matrix`
-- [Nostr](/channels/nostr) — `@symi/nostr`
-- [Zalo](/channels/zalo) — `@symi/zalo`
-- [Microsoft Teams](/channels/msteams) — `@symi/msteams`
-- Google Antigravity OAuth（提供商认证）— 作为 `google-antigravity-auth` 捆绑（默认禁用）
-- Gemini CLI OAuth（提供商认证）— 作为 `google-gemini-cli-auth` 捆绑（默认禁用）
-- Qwen OAuth（提供商认证）— 作为 `qwen-portal-auth` 捆绑（默认禁用）
-- Copilot Proxy（提供商认证）— 本地 VS Code Copilot Proxy 桥接；与内置 `github-copilot` 设备登录不同（捆绑，默认禁用）
-
-Symi 插件是通过 jiti 在运行时加载的 **TypeScript 模块**。**配置验证不会执行插件代码**；它使用插件清单和 JSON Schema。参见 [插件清单](/plugins/manifest)。
-
-插件可以注册：
-
-- Gateway 网关 RPC 方法
-- Gateway 网关 HTTP 处理程序
-- 智能体工具
-- CLI 命令
-- 后台服务
-- 可选的配置验证
-- **Skills**（通过在插件清单中列出 `skills` 目录）
-- **自动回复命令**（不调用 AI 智能体即可执行）
-
-插件与 Gateway 网关**在同一进程中**运行，因此将它们视为受信任的代码。
-工具编写指南：[插件智能体工具](/plugins/agent-tools)。
-
-## 运行时辅助工具
-
-插件可以通过 `api.runtime` 访问选定的核心辅助工具。对于电话 TTS：
-
-```ts
-const result = await api.runtime.tts.textToSpeechTelephony({
-  text: "Hello from Symi",
-  cfg: api.config,
-});
-```
-
-注意事项：
-
-- 使用核心 `messages.tts` 配置（OpenAI 或 ElevenLabs）。
-- 返回 PCM 音频缓冲区 + 采样率。插件必须为提供商重新采样/编码。
-- Edge TTS 不支持电话。
-
-## 发现和优先级
-
-Symi 按顺序扫描：
-
-1. 配置路径
-
-- `plugins.load.paths`（文件或目录）
-
-2. 工作区扩展
-
-- `<workspace>/.symi/extensions/*.ts`
-- `<workspace>/.symi/extensions/*/index.ts`
-
-3. 全局扩展
-
-- `~/.symi/extensions/*.ts`
-- `~/.symi/extensions/*/index.ts`
-
-4. 捆绑扩展（随 Symi 一起发布，**默认禁用**）
-
-- `<symi>/extensions/*`
-
-捆绑插件必须通过 `plugins.entries.<id>.enabled` 或 `symi plugins enable <id>` 显式启用。已安装的插件默认启用，但可以用相同方式禁用。
-
-每个插件必须在其根目录中包含 `symi.plugin.json` 文件。如果路径指向文件，则插件根目录是文件的目录，必须包含清单。
-
-如果多个插件解析到相同的 id，上述顺序中的第一个匹配项获胜，较低优先级的副本被忽略。
-
-### 包集合
-
-插件目录可以包含带有 `symi.extensions` 的 `package.json`：
-
-```json
-{
-  "name": "my-pack",
-  "symi": {
-    "extensions": ["./src/safety.ts", "./src/tools.ts"]
-  }
-}
-```
-
-每个条目成为一个插件。如果包列出多个扩展，插件 id 变为 `name/<fileBase>`。
-
-如果你的插件导入 npm 依赖，请在该目录中安装它们以便 `node_modules` 可用（`npm install` / `pnpm install`）。
-
-### 渠道目录元数据
-
-渠道插件可以通过 `symi.channel` 广播新手引导元数据，通过 `symi.install` 广播安装提示。这使核心目录保持无数据。
-
-示例：
-
-```json
-{
-  "name": "@symi/nextcloud-talk",
-  "symi": {
-    "extensions": ["./index.ts"],
-    "channel": {
-      "id": "nextcloud-talk",
-      "label": "Nextcloud Talk",
-      "selectionLabel": "Nextcloud Talk (self-hosted)",
-      "docsPath": "/channels/nextcloud-talk",
-      "docsLabel": "nextcloud-talk",
-      "blurb": "Self-hosted chat via Nextcloud Talk webhook bots.",
-      "order": 65,
-      "aliases": ["nc-talk", "nc"]
-    },
-    "install": {
-      "npmSpec": "@symi/nextcloud-talk",
-      "localPath": "extensions/nextcloud-talk",
-      "defaultChoice": "npm"
-    }
-  }
-}
-```
-
-Symi 还可以合并**外部渠道目录**（例如，MPM 注册表导出）。将 JSON 文件放在以下位置之一：
-
-- `~/.symi/mpm/plugins.json`
-- `~/.symi/mpm/catalog.json`
-- `~/.symi/plugins/catalog.json`
-
-或将 `SYMI_PLUGIN_CATALOG_PATHS`（或 `SYMI_MPM_CATALOG_PATHS`）指向一个或多个 JSON 文件（逗号/分号/`PATH` 分隔）。每个文件应包含 `{ "entries": [ { "name": "@scope/pkg", "symi": { "channel": {...}, "install": {...} } } ] }`。
-
-## 插件 ID
-
-默认插件 id：
-
-- 包集合：`package.json` 的 `name`
-- 独立文件：文件基本名称（`~/.../voice-call.ts` → `voice-call`）
-
-如果插件导出 `id`，Symi 会使用它，但当它与配置的 id 不匹配时会发出警告。
-
-## 配置
-
-```json5
-{
-  plugins: {
-    enabled: true,
-    allow: ["voice-call"],
-    deny: ["untrusted-plugin"],
-    load: { paths: ["~/Projects/oss/voice-call-extension"] },
-    entries: {
-      "voice-call": { enabled: true, config: { provider: "twilio" } },
-    },
-  },
-}
-```
-
-字段：
-
-- `enabled`：主开关（默认：true）
-- `allow`：允许列表（可选）
-- `deny`：拒绝列表（可选；deny 优先）
-- `load.paths`：额外的插件文件/目录
-- `entries.<id>`：每个插件的开关 + 配置
-
-配置更改**需要重启 Gateway 网关**。
-
-验证规则（严格）：
-
-- `entries`、`allow`、`deny` 或 `slots` 中的未知插件 id 是**错误**。
-- 未知的 `channels.<id>` 键是**错误**，除非插件清单声明了渠道 id。
-- 插件配置使用嵌入在 `symi.plugin.json`（`configSchema`）中的 JSON Schema 进行验证。
-- 如果插件被禁用，其配置会保留并发出**警告**。
-
-## 插件槽位（独占类别）
-
-某些插件类别是**独占的**（一次只有一个活跃）。使用 `plugins.slots` 选择哪个插件拥有该槽位：
-
-```json5
-{
-  plugins: {
-    slots: {
-      memory: "memory-core", // or "none" to disable memory plugins
-    },
-  },
-}
-```
-
-如果多个插件声明 `kind: "memory"`，只有选定的那个加载。其他的被禁用并带有诊断信息。
-
-## 控制界面（schema + 标签）
-
-控制界面使用 `config.schema`（JSON Schema + `uiHints`）来渲染更好的表单。
-
-Symi 在运行时根据发现的插件增强 `uiHints`：
-
-- 为 `plugins.entries.<id>` / `.enabled` / `.config` 添加每插件标签
-- 在以下位置合并可选的插件提供的配置字段提示：
-  `plugins.entries.<id>.config.<field>`
-
-如果你希望插件配置字段显示良好的标签/占位符（并将密钥标记为敏感），请在插件清单中提供 `uiHints` 和 JSON Schema。
-
-示例：
-
-```json
-{
-  "id": "my-plugin",
-  "configSchema": {
-    "type": "object",
-    "additionalProperties": false,
-    "properties": {
-      "apiKey": { "type": "string" },
-      "region": { "type": "string" }
-    }
-  },
-  "uiHints": {
-    "apiKey": { "label": "API Key", "sensitive": true },
-    "region": { "label": "Region", "placeholder": "us-east-1" }
-  }
-}
-```
-
-## CLI
-
-```bash
-symi plugins list
-symi plugins info <id>
-symi plugins install <path>                 # copy a local file/dir into ~/.symi/extensions/<id>
-symi plugins install ./extensions/voice-call # relative path ok
-symi plugins install ./plugin.tgz           # install from a local tarball
-symi plugins install ./plugin.zip           # install from a local zip
-symi plugins install -l ./extensions/voice-call # link (no copy) for dev
-symi plugins install @symi/voice-call # install from npm
-symi plugins update <id>
-symi plugins update --all
-symi plugins enable <id>
-symi plugins disable <id>
-symi plugins doctor
-```
-
-`plugins update` 仅适用于在 `plugins.installs` 下跟踪的 npm 安装。
-
-插件也可以注册自己的顶级命令（例如：`symi voicecall`）。
-
-## 插件 API（概述）
-
-插件导出以下之一：
-
-- 函数：`(api) => { ... }`
-- 对象：`{ id, name, configSchema, register(api) { ... } }`
-
-## 插件钩子
-
-插件可以附带钩子并在运行时注册它们。这让插件可以捆绑事件驱动的自动化，而无需单独安装钩子包。
-
-### 示例
-
-```
-import { registerPluginHooksFromDir } from "symi/plugin-sdk";
-
-export default function register(api) {
-  registerPluginHooksFromDir(api, "./hooks");
-}
-```
-
-注意事项：
-
-- 钩子目录遵循正常的钩子结构（`HOOK.md` + `handler.ts`）。
-- 钩子资格规则仍然适用（操作系统/二进制文件/环境/配置要求）。
-- 插件管理的钩子在 `symi hooks list` 中显示为 `plugin:<id>`。
-- 你不能通过 `symi hooks` 启用/禁用插件管理的钩子；而是启用/禁用插件。
-
-## 提供商插件（模型认证）
-
-插件可以注册**模型提供商认证**流程，以便用户可以在 Symi 内运行 OAuth 或 API 密钥设置（无需外部脚本）。
-
-通过 `api.registerProvider(...)` 注册提供商。每个提供商暴露一个或多个认证方法（OAuth、API 密钥、设备码等）。这些方法驱动：
-
-- `symi models auth login --provider <id> [--method <id>]`
-
-示例：
-
-```ts
-api.registerProvider({
-  id: "acme",
-  label: "AcmeAI",
-  auth: [
-    {
-      id: "oauth",
-      label: "OAuth",
-      kind: "oauth",
-      run: async (ctx) => {
-        // Run OAuth flow and return auth profiles.
-        return {
-          profiles: [
-            {
-              profileId: "acme:default",
-              credential: {
-                type: "oauth",
-                provider: "acme",
-                access: "...",
-                refresh: "...",
-                expires: Date.now() + 3600 * 1000,
-              },
-            },
-          ],
-          defaultModel: "acme/opus-1",
-        };
-      },
-    },
-  ],
-});
-```
-
-注意事项：
-
-- `run` 接收带有 `prompter`、`runtime`、`openUrl` 和 `oauth.createVpsAwareHandlers` 辅助工具的 `ProviderAuthContext`。
-- 当需要添加默认模型或提供商配置时返回 `configPatch`。
-- 返回 `defaultModel` 以便 `--set-default` 可以更新智能体默认值。
-
-### 注册消息渠道
-
-插件可以注册**渠道插件**，其行为类似于内置渠道（WhatsApp、Telegram 等）。渠道配置位于 `channels.<id>` 下，由你的渠道插件代码验证。
-
-```ts
-const myChannel = {
-  id: "acmechat",
-  meta: {
-    id: "acmechat",
-    label: "AcmeChat",
-    selectionLabel: "AcmeChat (API)",
-    docsPath: "/channels/acmechat",
-    blurb: "demo channel plugin.",
-    aliases: ["acme"],
-  },
-  capabilities: { chatTypes: ["direct"] },
-  config: {
-    listAccountIds: (cfg) => Object.keys(cfg.channels?.acmechat?.accounts ?? {}),
-    resolveAccount: (cfg, accountId) =>
-      cfg.channels?.acmechat?.accounts?.[accountId ?? "default"] ?? {
-        accountId,
-      },
-  },
-  outbound: {
-    deliveryMode: "direct",
-    sendText: async () => ({ ok: true }),
-  },
-};
-
-export default function (api) {
-  api.registerChannel({ plugin: myChannel });
-}
-```
-
-注意事项：
-
-- 将配置放在 `channels.<id>` 下（而不是 `plugins.entries`）。
-- `meta.label` 用于 CLI/UI 列表中的标签。
-- `meta.aliases` 添加用于规范化和 CLI 输入的备用 id。
-- `meta.preferOver` 列出当两者都配置时要跳过自动启用的渠道 id。
-- `meta.detailLabel` 和 `meta.systemImage` 让 UI 显示更丰富的渠道标签/图标。
-
-### 编写新的消息渠道（分步指南）
-
-当你想要一个**新的聊天界面**（"消息渠道"）而不是模型提供商时使用此方法。
-模型提供商文档位于 `/providers/*` 下。
-
-1. 选择 id + 配置结构
-
-- 所有渠道配置位于 `channels.<id>` 下。
-- 对于多账户设置，优先使用 `channels.<id>.accounts.<accountId>`。
-
-2. 定义渠道元数据
-
-- `meta.label`、`meta.selectionLabel`、`meta.docsPath`、`meta.blurb` 控制 CLI/UI 列表。
-- `meta.docsPath` 应指向像 `/channels/<id>` 这样的文档页面。
-- `meta.preferOver` 让插件替换另一个渠道（自动启用优先选择它）。
-- `meta.detailLabel` 和 `meta.systemImage` 被 UI 用于详细文本/图标。
-
-3. 实现必需的适配器
-
-- `config.listAccountIds` + `config.resolveAccount`
-- `capabilities`（聊天类型、媒体、线程等）
-- `outbound.deliveryMode` + `outbound.sendText`（用于基本发送）
-
-4. 根据需要添加可选适配器
-
-- `setup`（向导）、`security`（私信策略）、`status`（健康/诊断）
-- `gateway`（启动/停止/登录）、`mentions`、`threading`、`streaming`
-- `actions`（消息操作）、`commands`（原生命令行为）
-
-5. 在插件中注册渠道
-
-- `api.registerChannel({ plugin })`
-
-最小配置示例：
-
-```json5
-{
-  channels: {
-    acmechat: {
-      accounts: {
-        default: { token: "ACME_TOKEN", enabled: true },
-      },
-    },
-  },
-}
-```
-
-最小渠道插件（仅出站）：
-
-```ts
-const plugin = {
-  id: "acmechat",
-  meta: {
-    id: "acmechat",
-    label: "AcmeChat",
-    selectionLabel: "AcmeChat (API)",
-    docsPath: "/channels/acmechat",
-    blurb: "AcmeChat messaging channel.",
-    aliases: ["acme"],
-  },
-  capabilities: { chatTypes: ["direct"] },
-  config: {
-    listAccountIds: (cfg) => Object.keys(cfg.channels?.acmechat?.accounts ?? {}),
-    resolveAccount: (cfg, accountId) =>
-      cfg.channels?.acmechat?.accounts?.[accountId ?? "default"] ?? {
-        accountId,
-      },
-  },
-  outbound: {
-    deliveryMode: "direct",
-    sendText: async ({ text }) => {
-      // deliver `text` to your channel here
-      return { ok: true };
-    },
-  },
-};
-
-export default function (api) {
-  api.registerChannel({ plugin });
-}
-```
-
-加载插件（扩展目录或 `plugins.load.paths`），重启 Gateway 网关，然后在配置中配置 `channels.<id>`。
-
-### 智能体工具
-
-参见专门指南：[插件智能体工具](/plugins/agent-tools)。
-
-### 注册 Gateway 网关 RPC 方法
-
-```ts
-export default function (api) {
-  api.registerGatewayMethod("myplugin.status", ({ respond }) => {
-    respond(true, { ok: true });
-  });
-}
-```
-
-### 注册 CLI 命令
-
-```ts
-export default function (api) {
-  api.registerCli(
-    ({ program }) => {
-      program.command("mycmd").action(() => {
-        console.log("Hello");
-      });
-    },
-    { commands: ["mycmd"] },
-  );
-}
-```
-
-### 注册自动回复命令
-
-插件可以注册自定义斜杠命令，**无需调用 AI 智能体**即可执行。这对于切换命令、状态检查或不需要 LLM 处理的快速操作很有用。
-
-```ts
-export default function (api) {
-  api.registerCommand({
-    name: "mystatus",
-    description: "Show plugin status",
-    handler: (ctx) => ({
-      text: `Plugin is running! Channel: ${ctx.channel}`,
-    }),
-  });
-}
-```
-
-命令处理程序上下文：
-
-- `senderId`：发送者的 ID（如可用）
-- `channel`：发送命令的渠道
-- `isAuthorizedSender`：发送者是否是授权用户
-- `args`：命令后传递的参数（如果 `acceptsArgs: true`）
-- `commandBody`：完整的命令文本
-- `config`：当前 Symi 配置
-
-命令选项：
-
-- `name`：命令名称（不带前导 `/`）
-- `description`：命令列表中显示的帮助文本
-- `acceptsArgs`：命令是否接受参数（默认：false）。如果为 false 且提供了参数，命令不会匹配，消息会传递给其他处理程序
-- `requireAuth`：是否需要授权发送者（默认：true）
-- `handler`：返回 `{ text: string }` 的函数（可以是异步的）
-
-带授权和参数的示例：
-
-```ts
-api.registerCommand({
-  name: "setmode",
-  description: "Set plugin mode",
-  acceptsArgs: true,
-  requireAuth: true,
-  handler: async (ctx) => {
-    const mode = ctx.args?.trim() || "default";
-    await saveMode(mode);
-    return { text: `Mode set to: ${mode}` };
-  },
-});
-```
-
-注意事项：
-
-- 插件命令在内置命令和 AI 智能体**之前**处理
-- 命令全局注册，适用于所有渠道
-- 命令名称不区分大小写（`/MyStatus` 匹配 `/mystatus`）
-- 命令名称必须以字母开头，只能包含字母、数字、连字符和下划线
-- 保留的命令名称（如 `help`、`status`、`reset` 等）不能被插件覆盖
-- 跨插件的重复命令注册将失败并显示诊断错误
-
-### 注册后台服务
-
-```ts
-export default function (api) {
-  api.registerService({
-    id: "my-service",
-    start: () => api.logger.info("ready"),
-    stop: () => api.logger.info("bye"),
-  });
-}
-```
-
-## 命名约定
-
-- Gateway 网关方法：`pluginId.action`（例如：`voicecall.status`）
-- 工具：`snake_case`（例如：`voice_call`）
-- CLI 命令：kebab 或 camel，但避免与核心命令冲突
-
-## Skills
-
-插件可以在仓库中附带 Skills（`skills/<name>/SKILL.md`）。
-使用 `plugins.entries.<id>.enabled`（或其他配置门控）启用它，并确保它存在于你的工作区/托管 Skills 位置。
-
-## 分发（npm）
-
-推荐的打包方式：
-
-- 主包：`symi`（本仓库）
-- 插件：`@symi/*` 下的独立 npm 包（例如：`@symi/voice-call`）
-
-发布契约：
-
-- 插件 `package.json` 必须包含带有一个或多个入口文件的 `symi.extensions`。
-- 入口文件可以是 `.js` 或 `.ts`（jiti 在运行时加载 TS）。
-- `symi plugins install <npm-spec>` 使用 `npm pack`，提取到 `~/.symi/extensions/<id>/`，并在配置中启用它。
-- 配置键稳定性：作用域包被规范化为 `plugins.entries.*` 的**无作用域** id。
-
-## 示例插件：Voice Call
-
-本仓库包含一个语音通话插件（Twilio 或 log 回退）：
-
-- 源码：`extensions/voice-call`
-- Skills：`skills/voice-call`
-- CLI：`symi voicecall start|status`
-- 工具：`voice_call`
-- RPC：`voicecall.start`、`voicecall.status`
-- 配置（twilio）：`provider: "twilio"` + `twilio.accountSid/authToken/from`（可选 `statusCallbackUrl`、`twimlUrl`）
-- 配置（dev）：`provider: "log"`（无网络）
-
-参见 [Voice Call](/plugins/voice-call) 和 `extensions/voice-call/README.md` 了解设置和用法。
-
-## 安全注意事项
-
-插件与 Gateway 网关在同一进程中运行。将它们视为受信任的代码：
-
-- 只安装你信任的插件。
-- 优先使用 `plugins.allow` 允许列表。
-- 更改后重启 Gateway 网关。
-
-## 测试插件
-
-插件可以（也应该）附带测试：
-
-- 仓库内插件可以在 `src/**` 下保留 Vitest 测试（例如：`src/plugins/voice-call.plugin.test.ts`）。
-- 单独发布的插件应运行自己的 CI（lint/构建/测试）并验证 `symi.extensions` 指向构建的入口点（`dist/index.js`）。

package/docs/zh-CN/tools/reactions.md

@@ -1,28 +0,0 @@
----
-read_when:
-  - 在任何渠道中处理表情回应相关工作
-summary: 跨渠道共享的表情回应语义
-title: 表情回应
-x-i18n:
-  generated_at: "2026-02-01T21:42:41Z"
-  model: claude-opus-4-5
-  provider: pi
-  source_hash: 0f11bff9adb4bd02604f96ebe2573a623702796732b6e17dfeda399cb7be0fa6
-  source_path: tools/reactions.md
-  workflow: 15
----
-
-# 表情回应工具
-
-跨渠道共享的表情回应语义：
-
-- 添加表情回应时，`emoji` 为必填项。
-- `emoji=""` 在支持的情况下移除机器人的表情回应。
-- `remove: true` 在支持的情况下移除指定的表情（需要提供 `emoji`）。
-
-渠道说明：
-
-- **Google Chat**：空 `emoji` 移除应用在该消息上的表情回应；`remove: true` 仅移除指定的表情。
-- **Telegram**：空 `emoji` 移除机器人的表情回应；`remove: true` 同样移除表情回应，但工具验证仍要求 `emoji` 为非空值。
-- **WhatsApp**：空 `emoji` 移除机器人的表情回应；`remove: true` 映射为空 emoji（仍需提供 `emoji`）。
-- **Signal**：当启用 `channels.signal.reactionNotifications` 时，收到的表情回应通知会触发系统事件。