CLI

Univer CLI is a local Office automation application built with Univer Office SDK. It gives your existing agent content commands and Skills for working with Excel, Word, and PowerPoint files, or creating spreadsheets, documents, presentations, relational tables, and canvases. Results stay on your machine.

CLI (Command-Line Interface) is currently the primary way to operate Univer, replacing the earlier MCP-first approach to agent integration. Univer CLI provides the univer command and Skills: agents edit, inspect and deliver content through their command execution tools, while the local Viewer provides preview and review.

Install and try · How Skills work · Skills directory

Use the agent you already work with

You can use Univer CLI with these agents:

OpenCode · Claude Code · OpenClaw · Hermes · Codex · WorkBuddy · Kimi Work

The shared interface is the univer command and version-matched operational guidance. Hosts with Agent Skills support can load the official Skill; agents with command execution can also call it through their own tool layer. For host-specific experiences such as conversation preview cards, explore the integration projects.

See your first result

Use Node.js 24 or newer and install in the environment used by your agent:

npm install --global univer-cli@latestnpx skills add dream-num/skills -s univer-cli -guniver doctor

univer doctor checks the local runtime. The Skill helps the agent discover commands, load product-specific guidance, inspect content, and deliver results.

Open the official sample

In a new empty directory, send this to your agent:

Use Univer CLI to explore the official sample.Download https://univer.ai/cli-assets/hello.univer to hello.univer in the current directory.List its contents, give me the local Viewer link, and explain what I can try.

Opening existing content gives you an immediate look at the native editors. Next, ask the agent to revise it or try the creation task below.

Skills: operational guidance for agents

Skills organize the content model, editing workflow, Facade API discovery, and verification requirements into guidance an agent can read. They help it find the capabilities needed for a task, from editing through review and delivery.

Discovery entry: The univer-cli Skill installed in your agent helps it recognize Office tasks, then load full guidance from the local CLI.

Runtime Skills: These ship with the CLI and match its installed commands and Facade APIs. Load core first, then the target product; add the relevant topic for embeds or cross-content formulas.

Load guidance for the task

The agent usually reads this guidance itself; developers can also inspect it directly:

univer skills listuniver skills get coreuniver skills get sheetuniver skills path sheet

list shows installed Skills, get reads guidance, and path returns the local directory. Use univer skills get core --full to include references and templates. Look up specific APIs as needed with univer api find and univer api show.

Skills directory

Follow a name to browse its source guide. For actual tasks, use the version returned by your local univer skills get <name>.

For example, to embed a spreadsheet in a document, load core → doc + sheet → embed. Add cross-unit-formula when a Sheet cell or shape references data from other content. There is no need to load every guide upfront. After updating the CLI, reload core and the relevant product and topic Skills.

What you can build

• Turn data into deliverables: Clean spreadsheets, write formulas, add charts and pivots, lay out reports with headers and footers, or build a presentation from an outline.
• Keep content connected: One .univer file can hold multiple content types linked through formulas, chart references, and embeds.
• Verify the result: Read the actual content model through Facade, then use screenshots and presentation layout checks to find overflowing, overlapping, or off-page text.
• Review before delivery: The agent works in an isolated Worktree and returns a local Viewer link. Inspect differences, request revisions, merge or discard, and export supported Office formats. Canvases file import and export are not currently available.

Try a task like this

Use Univer CLI to create a monthly expense sheet with date, category, amount, and five sample rows. Add a total formula and a chart summarized by category. Check the data and rendered result, give me the Viewer link, and do not merge before my review.

How Office SDK powers it

Office SDK supplies the Headless content runtime, Facade API, calculation, rendering, versions, and Worktrees. The CLI assembles these into terminal commands and version-matched Skills, and owns local .univer storage, the Gateway, and the Viewer. Agent-authored content can move directly into editor previews and standard file delivery.

Try it and explore the source

Quick start · Source repository

Explore the underlying capabilities

• Headless and server-side calculation
• Document loading and content operations
• Worktree

All examples