--- read_when: - 你正在向插件添加设置向导 - 你需要理解 setup-entry.ts 与 index.ts 的区别 - 你正在定义插件配置架构或 package.json 的 openclaw 元数据 sidebarTitle: Setup and config summary: 设置向导、setup-entry.ts、配置模式和 package.json 元数据 title: 插件设置和配置 x-i18n: generated_at: "2026-07-05T11:33:04Z" model: gpt-5.5 postprocess_version: locale-links-v1 provider: openai source_hash: 3b47e1f18a92871c442980168e302c82d7aa9a38b38bbbeed4add9dd6479365b source_path: plugins/sdk-setup.md workflow: 16 --- 插件打包（`package.json` 元数据）、清单（`openclaw.plugin.json`）、设置入口和配置 schema 的参考。 **想看 walkthrough？** how-to 指南会结合上下文介绍打包：[渠道插件](/zh-CN/plugins/sdk-channel-plugins#step-1-package-and-manifest) 和 [提供商插件](/zh-CN/plugins/sdk-provider-plugins#step-1-package-and-manifest)。 ## 包元数据 你的 `package.json` 需要一个 `openclaw` 字段，用于告诉插件系统你的插件提供什么： ```json { "name": "@myorg/openclaw-my-channel", "version": "1.0.0", "type": "module", "openclaw": { "extensions": ["./index.ts"], "setupEntry": "./setup-entry.ts", "channel": { "id": "my-channel", "label": "My Channel", "blurb": "Short description of the channel." } } } ``` ```json openclaw-clawhub-package.json { "name": "@myorg/openclaw-my-plugin", "version": "1.0.0", "type": "module", "dependencies": { "typebox": "1.1.39" }, "peerDependencies": { "openclaw": ">=2026.3.24-beta.2" }, "openclaw": { "extensions": ["./index.ts"], "compat": { "pluginApi": ">=2026.3.24-beta.2", "minGatewayVersion": "2026.3.24-beta.2" }, "build": { "openclawVersion": "2026.3.24-beta.2", "pluginSdkVersion": "2026.3.24-beta.2" } } } ``` 在 ClawHub 上外部发布需要 `compat` 和 `build`。规范发布片段位于 `docs/snippets/plugin-publish/`。 ### `openclaw` 字段 入口点文件（相对于包根目录）。适用于工作区和 git checkout 开发的有效源入口。 `extensions` 对应的已构建 JavaScript peer，在 OpenClaw 加载已安装的 npm 包时优先使用。源/构建解析顺序见 [SDK 入口点](/zh-CN/plugins/sdk-entrypoints)。 轻量的仅设置入口（可选）。 `setupEntry` 对应的已构建 JavaScript peer。要求同时设置 `setupEntry`。 `{ id, label }` 后备插件身份，当插件没有可用于派生 id 或 label 的渠道/提供商元数据时使用。 用于设置、选择器、快速开始和状态界面的渠道目录元数据。 安装提示：`npmSpec`、`localPath`、`defaultChoice`、`minHostVersion`、`expectedIntegrity`、`allowInvalidConfigRecovery`、`requiredPlatformPackages`。 启动行为标志。 此插件支持的 `pluginApi` 版本范围。外部 ClawHub 发布需要此字段。 提供商 id（`providers: string[]`）是清单元数据，不是包元数据。请在 `openclaw.plugin.json` 中声明它们，而不是这里，见 [插件清单](/zh-CN/plugins/manifest)。 ### `openclaw.channel` `openclaw.channel` 是轻量包元数据，用于运行时加载前的渠道发现和设置界面。 | 字段 | 类型 | 含义 | | -------------------------------------- | ---------- | ----------------------------------------------------------------------------- | | `id` | `string` | 规范渠道 id。 | | `label` | `string` | 主要渠道标签。 | | `selectionLabel` | `string` | 当需要与 `label` 不同时，用于选择器/设置的标签。 | | `detailLabel` | `string` | 用于更丰富渠道目录和状态界面的次级详情标签。 | | `docsPath` | `string` | 用于设置和选择链接的文档路径。 | | `docsLabel` | `string` | 当文档链接标签需要与渠道 id 不同时使用的覆盖标签。 | | `blurb` | `string` | 简短的新手引导/目录描述。 | | `order` | `number` | 渠道目录中的排序顺序。 | | `aliases` | `string[]` | 用于渠道选择的额外查找别名。 | | `preferOver` | `string[]` | 此渠道应优先于的低优先级插件/渠道 id。 | | `systemImage` | `string` | 渠道 UI 目录的可选图标/系统图片名称。 | | `selectionDocsPrefix` | `string` | 选择界面中文档链接前的前缀文本。 | | `selectionDocsOmitLabel` | `boolean` | 在选择文案中直接显示文档路径，而不是带标签的文档链接。 | | `selectionExtras` | `string[]` | 追加到选择文案中的额外短字符串。 | | `markdownCapable` | `boolean` | 标记该渠道支持 markdown，用于出站格式化决策。 | | `exposure` | `object` | 控制渠道在设置、已配置列表和文档界面中的可见性。 | | `quickstartAllowFrom` | `boolean` | 将此渠道加入标准快速开始 `allowFrom` 设置流程。 | | `forceAccountBinding` | `boolean` | 即使只有一个账号，也要求显式账号绑定。 | | `preferSessionLookupForAnnounceTarget` | `boolean` | 为此渠道解析公告目标时优先使用会话查找。 | 示例： ```json { "openclaw": { "channel": { "id": "my-channel", "label": "My Channel", "selectionLabel": "My Channel (self-hosted)", "detailLabel": "My Channel Bot", "docsPath": "/channels/my-channel", "docsLabel": "my-channel", "blurb": "Webhook-based self-hosted chat integration.", "order": 80, "aliases": ["mc"], "preferOver": ["my-channel-legacy"], "selectionDocsPrefix": "Guide:", "selectionExtras": ["Markdown"], "markdownCapable": true, "exposure": { "configured": true, "setup": true, "docs": true }, "quickstartAllowFrom": true } } } ``` `exposure` 支持： - `configured`：在已配置/状态样式的列表界面中包含该渠道 - `setup`：在交互式设置/配置选择器中包含该渠道 - `docs`：在文档/导航界面中将该渠道标记为面向公众 `showConfigured` 和 `showInSetup` 仍作为旧版别名受支持。优先使用 `exposure`。 ### `openclaw.install` `openclaw.install` 是包元数据，不是清单元数据。 | 字段 | 类型 | 含义 | | ---------------------------- | ----------------------------------- | ------------------------------------------------------------------------------------ | | `clawhubSpec` | `string` | 用于安装/更新和新手引导按需安装流程的规范 ClawHub spec。 | | `npmSpec` | `string` | 用于安装/更新后备流程的规范 npm spec。 | | `localPath` | `string` | 本地开发或内置安装路径。 | | `defaultChoice` | `"clawhub"` \| `"npm"` \| `"local"` | 当有多个来源可用时，首选安装来源。 | | `minHostVersion` | `string` | 最低支持的 OpenClaw 版本，`>=x.y.z` 或 `>=x.y.z-prerelease`。 | | `expectedIntegrity` | `string` | 预期的 npm dist 完整性字符串，通常为 `sha512-...`，用于固定安装。 | | `allowInvalidConfigRecovery` | `boolean` | 允许内置插件重新安装流程从特定的陈旧配置失败中恢复。 | | `requiredPlatformPackages` | `string[]` | npm 安装期间验证的必需平台特定 npm 别名。 | 交互式新手引导会将 `openclaw.install` 用于按需安装界面：如果你的插件在运行时加载前暴露提供商凭证选项或渠道设置/目录元数据，新手引导可以提示选择 ClawHub、npm 或本地安装，安装或启用插件，然后继续所选流程。ClawHub 选项使用 `clawhubSpec`，存在时优先使用；npm 选项需要带注册表 `npmSpec` 的可信目录元数据（精确版本和 `expectedIntegrity` 是可选固定项，设置后会在安装/更新时强制执行）。将“显示什么”放在 `openclaw.plugin.json` 中，将“如何安装”放在 `package.json` 中。 如果设置了 `minHostVersion`，安装和非内置清单注册表加载都会强制执行它。旧版 host 会跳过外部插件；无效版本字符串会被拒绝。内置源插件假定与 host checkout 版本一致。 对于固定的 npm 安装，请在 `npmSpec` 中保留精确版本，并添加预期 artifact 完整性： ```json { "openclaw": { "install": { "npmSpec": "@wecom/wecom-openclaw-plugin@1.2.3", "expectedIntegrity": "sha512-REPLACE_WITH_NPM_DIST_INTEGRITY", "defaultChoice": "npm" } } } ``` `allowInvalidConfigRecovery` 不是损坏配置的通用绕过机制。它只用于狭义的内置插件恢复，允许重新安装/设置修复已知升级残留，例如缺少内置插件路径，或同一插件的陈旧 `channels.` 条目。如果配置因无关原因损坏，安装仍会 fail closed，并提示操作员运行 `openclaw doctor --fix`。 ### 延迟完整加载 渠道插件可以通过以下配置选择延迟加载： ```json { "openclaw": { "extensions": ["./index.ts"], "setupEntry": "./setup-entry.ts", "startup": { "deferConfiguredChannelFullLoadUntilAfterListen": true } } } ``` 启用后，即使对于已配置的渠道，OpenClaw 在监听前启动阶段也只加载 `setupEntry`。完整入口会在 Gateway 网关开始监听后加载。 只有当你的 `setupEntry` 注册了 Gateway 网关开始监听前所需的一切（渠道注册、HTTP 路由、Gateway 网关方法）时，才启用延迟加载。如果完整入口拥有必需的启动能力，请保留默认行为。 如果你的设置/完整入口注册 Gateway 网关 RPC 方法，请将它们放在插件专属前缀下。保留的核心 admin 命名空间（`config.*`、`exec.approvals.*`、`wizard.*`、`update.*`）仍由核心拥有，并始终规范化为 `operator.admin`。 ## 插件清单 每个原生插件都必须在包根目录随附一个 `openclaw.plugin.json`。OpenClaw 使用它在不执行插件代码的情况下验证配置。 ```json { "id": "my-plugin", "name": "My Plugin", "description": "Adds My Plugin capabilities to OpenClaw", "configSchema": { "type": "object", "additionalProperties": false, "properties": { "webhookSecret": { "type": "string", "description": "Webhook verification secret" } } } } ``` 对于渠道插件，添加 `channels`（提供商插件则添加 `providers`）： ```json { "id": "my-channel", "channels": ["my-channel"], "configSchema": { "type": "object", "additionalProperties": false, "properties": {} } } ``` 即使没有配置的插件也必须随附 schema。空 schema 是有效的： ```json { "id": "my-plugin", "configSchema": { "type": "object", "additionalProperties": false } } ``` 完整 schema 参考见 [插件清单](/zh-CN/plugins/manifest)。 ## ClawHub 发布 Skills 和插件包使用不同的 ClawHub 发布命令。对于插件包，请使用特定于包的命令： ```bash clawhub package publish your-org/your-plugin --dry-run clawhub package publish your-org/your-plugin ``` `clawhub skill publish ` 是用于发布技能文件夹的另一个命令，不是插件包。见 [在 ClawHub 上发布](/zh-CN/clawhub/publishing)。 ## 设置入口 `setup-entry.ts` 是 `index.ts` 的轻量替代项，OpenClaw 只需要设置界面（新手引导、配置修复、已禁用渠道检查）时会加载它： ```typescript // setup-entry.ts import { defineSetupPluginEntry } from "openclaw/plugin-sdk/channel-core"; import { myChannelPlugin } from "./src/channel.js"; export default defineSetupPluginEntry(myChannelPlugin); ``` 这会避免在设置流程期间加载繁重的运行时代码（加密库、CLI 注册、后台服务）。 在 sidecar 模块中保留设置安全导出的内置工作区渠道，可以改用 `openclaw/plugin-sdk/channel-entry-contract` 中的 `defineBundledChannelSetupEntry(...)`，而不是 `defineSetupPluginEntry(...)`。该内置契约还支持可选的 `runtime` 导出，因此设置时的运行时接线可以保持轻量且明确。 - 渠道已禁用，但需要设置/新手引导界面。 - 渠道已启用但未配置。 - 已启用延迟加载（`deferConfiguredChannelFullLoadUntilAfterListen`）。 - 渠道插件对象（通过 `defineSetupPluginEntry`）。 - Gateway 网关监听前所需的任何 HTTP 路由。 - 启动期间所需的任何 Gateway 网关方法。 这些启动 Gateway 网关方法仍应避免使用保留的核心管理命名空间，例如 `config.*` 或 `update.*`。 - CLI 注册。 - 后台服务。 - 繁重的运行时导入（加密、SDK）。 - 仅在启动后才需要的 Gateway 网关方法。 ### 窄设置辅助导入 对于设置专用热路径，如果你只需要设置界面的一部分，请优先使用窄设置辅助接口，而不是更宽泛的 `plugin-sdk/setup` 总入口： | 导入路径 | 用途 | 关键导出 | | ---------------------------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `plugin-sdk/setup-runtime` | 设置时运行时辅助工具，可在 `setupEntry` / 延迟渠道启动中保持可用 | `createSetupTranslator`, `createPatchedAccountSetupAdapter`, `createEnvPatchedAccountSetupAdapter`, `createSetupInputPresenceValidator`, `noteChannelLookupFailure`, `noteChannelLookupSummary`, `promptResolvedAllowFrom`, `splitSetupEntries`, `createAllowlistSetupWizardProxy`, `createDelegatedSetupWizardProxy` | | `plugin-sdk/setup-adapter-runtime` | 已弃用的兼容别名；请使用 `plugin-sdk/setup-runtime` | `createEnvPatchedAccountSetupAdapter` | | `plugin-sdk/setup-tools` | 设置/安装 CLI/归档/文档辅助工具 | `formatCliCommand`, `detectBinary`, `extractArchive`, `resolveBrewExecutable`, `formatDocsLink`, `CONFIG_DIR` | 当你需要完整的共享设置工具箱时，请使用更宽泛的 `plugin-sdk/setup` 接口，包括 `moveSingleAccountChannelSectionToDefaultAccount(...)` 等配置补丁辅助工具。 使用 `createSetupTranslator(...)` 处理固定的设置向导文案。它遵循 CLI 向导语言环境（`OPENCLAW_LOCALE`，然后是系统语言环境变量），并回退到英语。将特定于插件的设置文本保留在插件拥有的代码中，并且仅将共享目录键用于常见设置标签、状态文本和官方内置插件设置文案。 这些设置补丁适配器在导入时保持热路径安全。它们的内置单账号提升契约界面查找是惰性的，因此导入 `plugin-sdk/setup-runtime` 不会在适配器实际使用前提前加载内置契约界面发现。 ### 渠道拥有的单账号提升 当渠道从单账号顶层配置升级到 `channels..accounts.*` 时，默认共享行为会将提升后的账号级值移动到 `accounts.default`。 内置渠道可以通过它们的设置契约界面缩小或覆盖该提升： - `singleAccountKeysToMove`：应移动到提升后账号的额外顶层键 - `namedAccountPromotionKeys`：当命名账号已存在时，只有这些键会移动到提升后的账号；共享策略/投递键保留在渠道根部 - `resolveSingleAccountPromotionTarget(...)`：选择哪个现有账号接收提升后的值 Matrix 是当前的内置示例。如果恰好已有一个命名 Matrix 账号，或者 `defaultAccount` 指向现有的非规范键（例如 `Ops`），提升会保留该账号，而不是创建新的 `accounts.default` 条目。 ## 配置 schema 插件配置会根据你的清单中的 JSON Schema 进行验证。用户通过以下方式配置插件： ```json5 { plugins: { entries: { "my-plugin": { config: { webhookSecret: "abc123", }, }, }, }, } ``` 你的插件会在注册期间以 `api.pluginConfig` 接收此配置。 对于特定于渠道的配置，请改用渠道配置部分： ```json5 { channels: { "my-channel": { token: "bot-token", allowFrom: ["user1", "user2"], }, }, } ``` ### 构建渠道配置 schema 使用 `buildChannelConfigSchema` 将 Zod schema 转换为插件拥有的配置制品所使用的 `ChannelConfigSchema` 包装器： ```typescript import { z } from "zod"; import { buildChannelConfigSchema } from "openclaw/plugin-sdk/channel-config-schema"; const accountSchema = z.object({ token: z.string().optional(), allowFrom: z.array(z.string()).optional(), accounts: z.object({}).catchall(z.any()).optional(), defaultAccount: z.string().optional(), }); const configSchema = buildChannelConfigSchema(accountSchema); ``` 如果你已经将契约编写为 JSON Schema 或 TypeBox，请使用直接辅助工具，这样 OpenClaw 可以在元数据路径上跳过 Zod 到 JSON Schema 的转换： ```typescript import { Type } from "typebox"; import { buildJsonChannelConfigSchema } from "openclaw/plugin-sdk/channel-config-schema"; const configSchema = buildJsonChannelConfigSchema( Type.Object({ token: Type.Optional(Type.String()), allowFrom: Type.Optional(Type.Array(Type.String())), }), ); ``` 对于第三方插件，冷路径契约仍然是插件清单：将生成的 JSON Schema 镜像到 `openclaw.plugin.json#channelConfigs`，这样配置 schema、设置和 UI 界面就可以在不加载运行时代码的情况下检查 `channels.`。 ## 设置向导 渠道插件可以为 `openclaw onboard` 提供交互式设置向导。该向导是 `ChannelPlugin` 上的 `ChannelSetupWizard` 对象： ```typescript import type { ChannelSetupWizard } from "openclaw/plugin-sdk/channel-setup"; const setupWizard: ChannelSetupWizard = { channel: "my-channel", status: { configuredLabel: "Connected", unconfiguredLabel: "Not configured", resolveConfigured: ({ cfg }) => Boolean((cfg.channels as any)?.["my-channel"]?.token), }, credentials: [ { inputKey: "token", providerHint: "my-channel", credentialLabel: "Bot token", preferredEnvVar: "MY_CHANNEL_BOT_TOKEN", envPrompt: "Use MY_CHANNEL_BOT_TOKEN from environment?", keepPrompt: "Keep current token?", inputPrompt: "Enter your bot token:", inspect: ({ cfg, accountId }) => { const token = (cfg.channels as any)?.["my-channel"]?.token; return { accountConfigured: Boolean(token), hasConfiguredValue: Boolean(token), }; }, }, ], }; ``` `ChannelSetupWizard` 还支持 `textInputs`、`dmPolicy`、`allowFrom`、`groupAccess`、`prepare`、`finalize` 等。完整内置示例见 Discord 插件的 `src/setup-core.ts`。 对于只需要标准 `note -> prompt -> parse -> merge -> patch` 流程的私信允许列表提示，请优先使用 `openclaw/plugin-sdk/setup` 中的共享设置辅助工具：`createPromptParsedAllowFromForAccount(...)`、`createTopLevelChannelParsedAllowFromPrompt(...)` 和 `createNestedChannelParsedAllowFromPrompt(...)`。 对于仅因标签、评分和可选额外行而有所差异的渠道设置状态块，请优先使用 `openclaw/plugin-sdk/setup` 中的 `createStandardChannelSetupStatus(...)`，而不是在每个插件中手写相同的 `status` 对象。 对于只应在特定上下文中出现的可选设置界面，请使用 `openclaw/plugin-sdk/channel-setup` 中的 `createOptionalChannelSetupSurface`： ```typescript import { createOptionalChannelSetupSurface } from "openclaw/plugin-sdk/channel-setup"; const setupSurface = createOptionalChannelSetupSurface({ channel: "my-channel", label: "My Channel", npmSpec: "@myorg/openclaw-my-channel", docsPath: "/channels/my-channel", }); // Returns { setupAdapter, setupWizard } ``` 当你只需要该可选安装界面的一半时，`plugin-sdk/channel-setup` 还会暴露更底层的 `createOptionalChannelSetupAdapter(...)` 和 `createOptionalChannelSetupWizard(...)` 构建器。 生成的可选适配器/向导会在真实配置写入时以失败即关闭的方式处理。它们在 `validateInput`、`applyAccountConfig` 和 `finalize` 中复用同一条需要安装的消息，并在设置了 `docsPath` 时追加文档链接。 对于二进制支持的设置 UI，优先使用共享的委托辅助工具，而不是在每个渠道中复制相同的二进制/状态粘合逻辑： - `createDetectedBinaryStatus(...)` 用于仅因标签、提示、评分和二进制检测而变化的状态块 - `createCliPathTextInput(...)` 用于路径支持的文本输入 - 当 `setupEntry` 需要延迟转发到更重的完整向导时，使用 `createDelegatedSetupWizardStatusResolvers(...)`、`createDelegatedPrepare(...)`、`createDelegatedFinalize(...)` 和 `createDelegatedResolveConfigured(...)` - 当 `setupEntry` 只需要委托 `textInputs[*].shouldPrompt` 决策时，使用 `createDelegatedTextInputShouldPrompt(...)` ## 发布和安装 **外部插件：**发布到 [ClawHub](/clawhub)，然后安装： ```bash openclaw plugins install @myorg/openclaw-my-plugin ``` 在发布切换期间，裸包规范会从 npm 安装，除非名称匹配某个内置或官方插件 ID；在这种情况下，OpenClaw 会改用该本地/官方副本。使用 `clawhub:`、`npm:`、`git:` 或 `npm-pack:` 来确定性地选择来源 — 参见[管理插件](/zh-CN/plugins/manage-plugins)。 ```bash openclaw plugins install clawhub:@myorg/openclaw-my-plugin ``` 当包尚未迁移到 ClawHub，或你在迁移期间需要直接的 npm 安装路径时，请使用 npm： ```bash openclaw plugins install npm:@myorg/openclaw-my-plugin ``` **仓库内插件：**放在内置插件工作区树下；它们会在构建期间自动被发现。 对于来自 npm 的安装，`openclaw plugins install` 会将包安装到 `~/.openclaw/npm/projects` 下的每插件项目中，并禁用生命周期脚本（`--ignore-scripts`）。保持插件依赖树为纯 JS/TS，并避免需要 `postinstall` 构建的包。 Gateway 网关启动不会安装插件依赖。npm/git/ClawHub 安装流程负责依赖收敛；本地插件必须已经安装其依赖。 内置包元数据是显式的，不会在 Gateway 网关启动时从构建后的 JavaScript 推断。运行时依赖属于拥有它们的插件包；打包版 OpenClaw 启动时绝不会修复或镜像插件依赖。 ## 相关 - [构建插件](/zh-CN/plugins/building-plugins) — 分步入门指南 - [插件清单](/zh-CN/plugins/manifest) — 完整清单架构参考 - [SDK 入口点](/zh-CN/plugins/sdk-entrypoints) — `definePluginEntry` 和 `defineChannelPluginEntry`