univer-workspace-cli

Univer Workspace CLI

用于远程编辑和检查 Univer Workspace 文件。此 CLI 提供 Space 发现、按任务隔离的 Worktree、与版本匹配的 Facade 指引、模型回读和浏览器审查。

univer-workspace-cli 独立于 univer，并非其变体：前者操作远程 Workspace 文件，后者操作本地 univerfiles。

安装并配置目标 Workspace：

npm install -g univer-workspace-cli
univer-workspace-cli config set workspace.origin https://workspace.example.com
univer-workspace-cli login --json

将首次登录命令中的验证 URL 和代码转告用户，然后停止。仅在用户确认批准后运行 --complete；等待批准期间不要轮询。

univer-workspace-cli login --complete --json
univer-workspace-cli doctor

保持 CLI 为最新版本

使用以下命令，将已安装的 CLI 与最新公开版本进行比较：

univer-workspace-cli --version
npm view univer-workspace-cli@latest version --registry=https://registry.npmjs.org/

完成当前 Workspace 任务后再升级。此 CLI 没有 update 命令；请显式安装新版本的软件包，然后重新加载其操作 Skills：

npm install -g univer-workspace-cli@latest
univer-workspace-cli doctor --json
univer-workspace-cli skills get core

从这里开始

本文档是发现入口，而非操作指南。在使用 Workspace 命令执行任务前，请从已安装的 CLI 加载完整的核心 Skill：

univer-workspace-cli skills get core          # remote model, workflow, evidence, and handoff
univer-workspace-cli skills get core --full   # include direct references

运行时 Skills 随 CLI 一同提供，因此其命令和 Facade API 与已安装版本相匹配。

核心模型

• 配置一个 Workspace 源，然后向其进行身份验证。
• Space 是用户浏览的文件容器。其树结构包含由 nodeId 标识的节点；附加到节点的 Univer 资源由 resourceId 标识。
• Unit 是可编辑的 Sheet、Doc、Slide、Base 或 Board 内容；其 Resource 在 Worktree 中暂存后，由 unitId 标识。
• 每个新任务都要在新的 Worktree 中开始。只有对同一任务返工时，才继续使用已知的 Worktree；当前 Worktree 或 Unit 不会自动隐式设置。
• 命令成功并不能证明结果正确。请回读已存储的模型，并在外观重要时检查渲染结果。

请使用公开的 CLI 和 Facade 接口。execute 会将捕获的变更作为一个 Worktree 修订提交，而合并仍须由用户明确审查决定。

Unit Skills

加载核心 Skill 后，在编辑内容前加载与目标顶层 Unit 相匹配的 Skill：

univer-workspace-cli skills get sheet
univer-workspace-cli skills get doc
univer-workspace-cli skills get slide
univer-workspace-cli skills get base
univer-workspace-cli skills get board

使用 univer-workspace-cli skills list 发现已安装的 Skill 集合。每个 Unit Skill 都负责其创建流程、注入的 Facade 根、回读指引和视觉验证要求。对于跨 Unit 组合，还需在 Host 和 Source Unit Skills 之后加载 univer-workspace-cli skills get embed 或 univer-workspace-cli skills get cross-unit-formula。

任务路由

任务	加载并使用
对 Personal/Team Space 文件进行身份验证或发现	core
在任务 Worktree 中暂存现有文件，或创建/导入新的 Unit	core + 目标 Unit
检查或编辑 Sheet 值、公式、格式、图表或表格	core + sheet
创建或完善 Doc 段落、富文本、表格、图表或分页	core + doc
构建或审查 Slide 页面、形状、文本、图片、表格或图表	core + slide
检查或编辑 Base 表格、字段、记录、视图或公式	core + base
构建或审查 Board 画布及其已验证元素	core + board
嵌入 Unit，或使用另一个 Unit 为 Chart 提供数据	core + Host + Source + embed
在公式或公式驱动的 Shape 中使用 Source 数据	core + Host + Source + cross-unit-formula
验证、截图、导出、标记为就绪或生成审查 URL	core + 目标 Unit

为什么使用 Univer Workspace CLI

• Space 发现会在远程文件进入 Worktree 前解析它们。
• Worktree 会将单个 Agent 任务隔离起来，直至审查、合并或丢弃。
• 离线 api show / api find 可解析与已安装 SDK 精确匹配的 Facade 符号。
• 运行时检查和 Workspace 审查页面可验证已存储和已渲染的结果。
• 导入/导出和截图使用 Workspace 产品运行时，而非无关的文件写入器。

请勿改用本地办公软件写入器，也不要绕过远程 Worktree 生命周期。请遵循已加载的核心 Skill 和 Unit Skills 所规定的受支持流程。

诊断

univer-workspace-cli --help
univer-workspace-cli doctor
univer-workspace-cli skills list
univer-workspace-cli skills path

使用 univer-workspace-cli <command> --help 查看准确语法。如果 CLI 不可用、未配置 Workspace 源站、缺少身份验证，或 doctor 报告存在阻断性运行时故障，请停止并报告诊断结果，不要切换工具。