package.json 中,命令位于 src/ 下,可选的 API 路由位于 src/api/ 下。命令通过 Enconvo 的扩展运行时执行;插件命令是一个默认导出的函数,而不是实现 Command 接口的类。
开始之前
你需要 Node.js 18 或更高版本、npm 或其他包管理器,并在你的 Mac 上运行 Enconvo。快速开始
在一个新文件夹中创建插件项目:npm run dev 会将插件构建到 Enconvo 中,并在你每次保存时重新构建。在 Enconvo 中搜索 Say Hello 即可运行。
插件名称来自文件夹名称。传入 --name、--title、--description 或 --author 可以自行指定这些信息。请不要使用 Enconvo 中已安装插件的名称,因为构建会覆盖已安装插件的文件;plugin create 也会拒绝这类名称。
如果要制作同时可安装在 Codex 和 Claude Code 中的插件,请改用 --template skills(技能)或 --template mcp(MCP 服务器)。有关这些包格式,请参阅 Plugin Formats;如需从本地文件夹、GitHub 或应用市场试用任何插件,请参阅安装插件。
plugin create、plugin validate 以及提交审核发布功能需要高于 0.1.173 版本的 @enconvo/api。如果你的版本没有这些命令,请按下面介绍的方式手动搭建项目。手动搭建项目
package.json:
categories 的第一项决定了插件在“插件”页面和商店中显示的分区:Productivity(效率)、Communication(通信)、Developer Tools(开发者工具)、Data & Analytics(数据与分析)、Finance(金融)、Creativity(创意)、Business & Operations(商业与运营)、Education & Research(教育与研究)或 Security(安全)。
安装 SDK,并将构建工具安装为开发依赖:
enconvo plugin build 会使用插件自带的 tsup 编译你的代码。如果没有安装它,构建工具就没有可用的编译器;较新的 SDK 会报错中止,较旧的 SDK 则会跳过命令编译直接结束。
创建 tsconfig.json:
assets/icon.png 处放置一张正方形的 PNG、JPEG、WebP 或 GIF 图标,大小不超过 5 MB。
添加命令
commands[].name 对应源代码的文件名。将以下内容写入 src/hello.ts:
hello_enconvo|hello。运行时的偏好设置和请求参数会合并到请求体中。
添加 Local API 路由
src/api/ 中的文件会在构建期间自动发现,无需在 commands[] 中配置。将以下内容写入 src/api/echo.ts:
hello_enconvo/echo。诸如 src/api/items/list.ts 这样的子目录路径会生成 hello_enconvo/items/list。具体的请求体结构请参阅已安装的 Local API 架构。
构建与测试
ready - built extension successfully。如果打印了 error 行,请修复报错指出的问题后重新构建。开发模式会监听文件改动并自动重新构建。API 架构会生成到插件的 skills/ 目录中。
在 Enconvo 运行时调用该路由:
发布到插件商店
检查插件
plugin validate 会在不上传任何内容的情况下,依据商店规则检查插件;Validation Codes 解释了它报告的各项问题。在构建完成后,它还会显示打包将包含的文件数量,以及哪些文件会被排除。它会检查:
- 名称仅包含字母、数字、点、短横线和下划线
version格式符合1.2.3- 插件包含标题
- 图标为不超过 5 MB 的 PNG、JPEG、WebP 或 GIF
metadata/ 文件夹中放入最多 8 张截图;商店中的插件页面会在简介下方按文件名顺序展示这些截图。
上传审核
plugin publish 会构建插件并使用你当前在 Enconvo 中登录的账户上传,因此 Enconvo 必须处于运行并已登录的状态。每个版本在上线商店之前都会经过 Enconvo 的审核。在新插件获批之前,只有你能看到它;在更新审核期间,商店会继续提供上一个已发布的版本。
每次更新都必须提高 package.json 中的 version。在开始构建之前,plugin publish 会向商店查询当前已发布的版本号,如果你的版本号不高于它,就会中止并提示下一个可用的版本号。仍在审核中或被退回的版本可以保持原版本号重新提交,新上传的包会替换旧的。
打包基于构建后的插件产物进行。.env 文件、node_modules、版本控制目录和 .zip 压缩包会自动排除,但仍请仔细检查,确保没有其他凭据或私人文件被打包进去。
审核人员会依据插件商店审核指南进行审核。建议在 package.json 中添加 review 对象,提供供审核人员测试的提示词,并通过 --review-notes 传入演示账户的登录信息;这些内容仅审核人员可见。
下一步
AI Model and Voice Plugins
将你自己的 AI 模型或文本转语音声音添加到 Enconvo 的选择器中
Extension API Reference
SDK 的核心构建模块
Plugin Formats
同时支持安装到 Codex 和 Claude Code 的技能与 MCP 插件
工作流
无需编写插件即可复用的多步骤流程