univer-cli

Univer CLI

Terminal-native authoring and inspection for multi-Unit .univer files. The CLI provides isolated worktrees, version-matched Facade guidance, model readback, and browser review.

Install:

npm install -g univer-cli
univer doctor

Keep the CLI current

Use these commands to compare the installed CLI with the latest public release:

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

When a newer version is available, complete the current Univer task before updating:

If univer update reports that the shared daemon must stop, rerun it with --force after confirming that stopping the daemon is safe. Reload core and the target Unit Skill after every update.

Start here

This file is the discovery entry, not the operational guide. Before using Univer commands for a task, load the complete core Skill from the installed CLI:

Runtime Skills ship with the CLI so their commands and Facade APIs match the installed version.

Core Model

• A .univer path is the authoritative multi-Unit target. Always address the file explicitly.
• A Unit is a top-level Sheet, Doc, Slide, Base, or Board identified by unitId; sheet names, pages, tables, ranges, shapes, and records live inside that Unit.
• trunk is the reviewed main line. A worktree is an isolated scope for agent changes; there is no implicit current worktree.
• Command success is not correctness evidence. Read back the target model, verify task-specific assertions, and inspect rendered output when appearance matters.

Use public CLI and Facade surfaces. The worktree commit path is the durable write boundary, and merge remains an explicit review decision.

Unit Skills

After core, load the Skill matching the target top-level Unit before authoring:

Use univer skills list to discover the installed set. Each Unit Skill owns its creation recipe, Facade entrypoints, readback guidance, and visual verification requirements.

For cross-Unit composition, load the additional Topic Skill after the host and child Unit Skills:

For a cross-Unit formula in a Sheet cell or formula-driven Shape, load its Topic Skill after the Host and Sheet or Base Source Unit Skills:

Task Routing

Why Univer CLI

• One .univer target can contain Sheet, Doc, Slide, Base, and Board Units addressed by unitId.
• Worktrees isolate agent changes until review and merge.
• Offline api show / api find resolves exact Facade symbols for the installed SDK.
• Runtime readback and the viewer verify the stored model and rendered result.
• Import/export and screenshots use the product runtime rather than unrelated file writers.

Do not edit .univer storage directly or substitute unrelated writers. Follow the loaded core and Unit Skills for the supported path.

Diagnose

Use univer help <command> for exact syntax. If the CLI is unavailable or doctor reports a blocking runtime failure, stop and report the diagnostic instead of switching tools.