Skip to content
1 min

Examples

Learn Univer CLI SDK content operations, Office file import and export, visual inspection, and Worktree in order.

univer-cli-examples contains four independent, runnable teaching applications. Each directory has its own package.json and lockfile. Every example retains the preceding capabilities and adds one topic.

Learning order

ExampleLearnAdded capability
01-content-operationsRead, edit, and view Sheet, Doc, and Slide UnitsCLI, Server, Web, Collaboration Runtime
02-file-exchangeImport and export Office filesExchange, UnitData, native binding
03-visual-inspectionCheck the actual rendered UnitRender Page, Screenshot, Layout Lint
04-worktreeIsolate agent edits and hand them to human reviewWorktree, Ready, Merge, Reopen

Run an example

Use the same startup sequence inside any example directory:

Bash
pnpm install
pnpm build
pnpm link-cli
pnpm start-server

After the Server starts, run univer-example-cli from another terminal. Each example README contains its complete, copyable flow and an Agent skill prompt.

These are minimal teaching assemblies, not complete products. The application still owns commands, targets, identity and authorization, output, and deployment.