文档/Manifest 参考
通用开发

Manifest 参考

Manifest 参考

结构

字段类型必填说明
idstring反向域名,唯一标识
namestring显示名称,支持本地化
descriptionstring简短介绍
versionstring语义化版本
sdkapinumber推荐SDK API 版本,格式 YYMMDD(如 260428)
categorystring条件必填分类 ID(与 Nexus 同步,如 utilitiesproductivity),用于 UI 分组(sdkapi >= 260114 必填)
entrystringinit 入口文件路径
preloadstring渲染层预加载脚本
dev.enableboolean开发模式热重载
permissionsobject权限声明,见下方详情
permissionReasonsobject权限用途说明
acceptedInputTypesstringtextimagefileshtml
featuresobjectCoreBox 指令、Widget、Workflow 节点

SDK API 版本 (sdkapi)

sdkapi 字段用于声明插件兼容的 SDK API 版本。格式为 YYMMDD(年月日)。

  • 当前版本: 260428 (2026-04-28)
  • 支持列表: 251212260114260121260215260225260228260428
  • 未声明、非法、未列入支持列表或低于 251212: 运行时直接以 SDKAPI_BLOCKED 阻断
  • 251212 ~ 260113: 启用完整权限校验
  • 等于或高于 260114: 在 251212 基础上,要求声明 category(用于 UI 分组)
  • 等于或高于 260215: 可使用插件 SQLite SDK(usePluginSqlite
  • 等于或高于 260228: 启用插件 capability auth 基线
  • 260428: 当前推荐 marker,不新增额外运行时门槛

260114 起:建议补充 category 以参与 UI 分组展示;当 sdkapi >= 260114 且缺失 category 时,插件将被拒绝启动并在列表中标记问题。

建议新插件始终声明最新的 sdkapi 版本以获得完整的权限保护。

权限声明 (permissions)

权限系统控制插件对敏感 API 的访问。详见 Permission API 文档

声明格式

EXAMPLE.JSON
"permissions": {
  "required": ["clipboard.read", "network.internet"],
  "optional": ["storage.shared"]
},
"permissionReasons": {
  "clipboard.read": "读取剪贴板中的待翻译文本",
  "network.internet": "连接翻译服务 API"
}

可用权限

权限 ID风险说明
fs.read读取文件
fs.write写入文件
fs.execute执行文件
clipboard.read读取剪贴板
clipboard.write写入剪贴板(自动授予)
network.local本地网络
network.internet互联网访问
network.download下载文件
system.shell执行命令
system.notification系统通知
system.tray托盘交互
intelligence.basic基础智能能力
intelligence.admin管理级智能能力
intelligence.agents智能体
storage.plugin插件存储(自动授予)
storage.shared共享存储
storage.sqlite插件 SQLite 数据库访问
window.create创建窗口(自动授予)
window.capture屏幕截图

示例

EXAMPLE.JSON
{
  "id": "com.tuff.todo",
  "name": {
    "default": "待办",
    "en": "Todo"
  },
  "description": "快速记录与同步待办",
  "version": "1.3.0",
  "sdkapi": 260428,
  "category": "utilities",
  "entry": "init/index.ts",
  "features": [
    {
      "type": "corebox",
      "id": "todo.new",
      "title": "快速创建待办",
      "keywords": ["todo", "task"],
      "queryMode": "text"
    }
  ],
  "permissions": {
    "required": ["clipboard.read", "storage.sqlite"],
    "optional": ["storage.shared"]
  },
  "permissionReasons": {
    "clipboard.read": "读取剪贴板中的待办内容",
    "storage.sqlite": "将待办数据存储到本地 SQLite"
  },
  "acceptedInputTypes": ["text", "files"]
}

校验

  • id 必须唯一且只含字母数字点。
  • version 需遵循 major.minor.patch,自动比较以确定更新顺序。
  • permissions 包含 network 时需声明允许的域名。

常见错误

情况解决办法
未填写 entry指定 init/index.ts 并确保文件存在
权限过多被拒仅声明实际需要的权限,首版尽量最小化
features 关键词冲突使用命名空间(如 todo. 前缀)避免重复