Package 概览

按内容与协同、内容编译、渲染、进程和应用辅助能力选择全部 AI SDK package。

AI SDK 目前提供 25 个独立的 package。安装应用所需的基础功能包;当同一行的预设命令包默认终端交互符合产品需求时,再加入该预设命令包。

两类 Package

类型提供内容
基础功能包结构化 TypeScript API,不依赖 Commander,也不规定命令名称、输出和退出行为
预设命令包基于基础功能包封装一个原生 Commander Command,提供默认参数、help 和终端交互

预设命令包通常以 -command 结尾。并非每个基础功能包都需要预设命令包。

内容与协同 Runtime

这里的标准 headless Univer 由 Web SDK 的内容插件组合而成。内容包、UI 包和 engine-render 之间的分工见 Headless 包分类。下文的协同 Runtime 和渲染 Runtime 都是在内容运行时之上按需增加的能力。

业务需求基础功能包预设命令包
创建标准 headless Univer@univer-cli/headless-univer—
离线查询 Univer Facade API@univer-cli/api-reference@univer-cli/api-reference-command
准备并绑定一次 Facade execution@univer-cli/content-execution—
读取 Sheet、Doc 或 Slide 内容@univer-cli/content-inspection@univer-cli/content-inspection-command
运行单个协同 Unit@univer-cli/univer-collaboration-runtime—
在 Worker 中复用协同 Runtime@univer-cli/univer-collaboration-runtime-pool—

内容编译

业务需求基础功能包预设命令包
把 SVG 转成 Slide Facade code@univer-cli/svg-facade@univer-cli/svg-facade-command
把 Typst bundle 转成 Doc Facade code@univer-cli/doc-typst-facade@univer-cli/doc-typst-facade-command

渲染与诊断

业务需求基础功能包预设命令包
把 Unit 截成 PNG@univer-cli/unit-screenshot@univer-cli/unit-screenshot-command
对 Slide layout 做 lint@univer-cli/unit-layout-lint@univer-cli/unit-layout-lint-command
托管 Render Page,驱动浏览器@univer-cli/univer-render-runtime—
组装并构建 Render Page@univer-cli/univer-render-page—

进程与生命周期

业务需求基础功能包预设命令包
按 key 独占、缓存和回收有状态对象@univer-cli/generic-keyed-instance-pool—
让多个 CLI 进程访问同一个本地常驻进程@univer-cli/daemon@univer-cli/daemon-command

应用辅助能力

业务需求基础功能包预设命令包
声明、读取和持久化应用配置@univer-cli/config@univer-cli/config-command
查询、缓存和导出视觉资源@univer-cli/resource-library@univer-cli/resource-library-command

如何选择

  1. 先按业务需求找到对应的基础功能包。
  2. 默认的 Commander 交互符合产品需求时,再加入对应的预设命令包。
  3. CLI、Web 和 Server 共享同一个 Unit 时,使用 Collaboration Runtime,而不是直接访问协同数据库。
  4. 应用需要复用、跨进程访问或浏览器渲染时,再引入 pool、daemon 或 Render Runtime。
  5. 阅读目标 package 的 README,确认其公共 API、资源所有权和释放方式。

具体概念和核心用法见文档内容加载与读写、视觉检查和 Runtime 复用与 Daemon。

你觉得这篇文档如何?

© 2026 DreamNum Co., Ltd.