CLI

Bring local Office tools to your agent: install, open a sample, then create editable, calculable, reviewable results.

Univer CLI is a local Office automation application built on the Univer Office SDK. It adds content commands and Skills to the agent you already use. With these additions, the agent can work with existing Excel, Word, and PowerPoint files, and can create spreadsheets, documents, presentations, relational tables, and canvases. Results remain on your machine.

CLI (Command-Line Interface) is currently the primary way to operate Univer. It replaces the earlier MCP-first approach to agent integration. Univer CLI provides the univer command and Skills. Agents use their own command execution tools to edit, inspect, and deliver content, and preview and review take place in the local Viewer.

Install and try · How Skills work · Skills directory

Use the agent you already work with

Univer CLI supports the following agents:

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

These agents share a single interface: the univer command and operational guidance that matches the installed version. A host with Agent Skills support can load the official Skill, and an agent that can execute commands can also call Univer through its own tool layer. Host-specific features such as conversation preview cards are covered by the integration projects.

See your first result

Univer CLI requires Node.js 24 or newer. Install it in the environment where your agent runs:

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

univer doctor checks the local runtime. Through the Skill, the agent discovers commands, loads guidance for a specific product, inspects content, and delivers results.

Open the official sample

In a new, empty directory, send the following instruction to the agent:

text
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 displays the native editors immediately. You can then ask the agent to revise that content, or try the creation task below.

Skills: operational guidance for agents

These Skills enable an existing agent to create, edit, and check Office content through Univer CLI. First install the CLI and its discovery Skill, then load the task-specific guidance described below.

A Skill presents part of the product as guidance that an agent can read: the content model, the editing workflow, how to find Facade APIs, and the requirements for verification. On that basis, the agent determines which capabilities a task needs, from the first edit through review and delivery.

Discovery entry: The univer-cli Skill installed in the 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 topic Skill when the task involves embeds or cross-content formulas.

Load guidance for the task

In most cases the agent reads this guidance on its own. Developers can also inspect it directly:

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

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

Skills directory

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

SkillWhen to use it
coreShared workflow: understand Units and Worktrees, locate and edit content, verify it, and submit it for review.
sheetSpreadsheets (Sheet): data, formulas, formatting, charts, and result verification.
docDocuments (Doc): paragraphs, rich text, tables, charts, and page layout.
slidePresentations (Slide): pages, shapes, text, images, and visual checks.
baseRelational Table: tables, fields, records, and views.
boardCanvases: canvas elements, charts, and layout checks.
embedEmbeds: place content from one Unit inside another, and connect chart data sources.
cross-unit-formulaCross-content formulas: read Sheet ranges or Relational Table fields for calculations in Sheet cells or formula-driven shapes.

For example, to embed a spreadsheet in a document, load core → doc + sheet → embed. Add cross-unit-formula when a Sheet cell or a shape references data from other content. Loading every guide in advance is unnecessary. After updating the CLI, reload core and the product and topic Skills that you use.

What you can build

  • Turn data into a deliverable: clean the sheet, write formulas, add charts and pivot tables, lay out a report 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 text that overflows, overlaps, or runs off the page.
  • Review before delivery: the agent works in an isolated Worktree and returns a local Viewer link. Inspect the differences, request revisions, merge or discard the result, and export the supported Office formats. Canvas file import and export are not available yet.

Try a task like this

Use Univer CLI to create a monthly expense sheet with date, category, and amount, and five sample rows. Add a total formula and a chart summarized by category. Check the data and the 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, the Facade API, calculation, rendering, versions, and Worktrees. The CLI assembles these capabilities into terminal commands and version-matched Skills, and it owns local .univer storage, the Gateway, and the Viewer. Content that the agent writes can move directly into editor previews and standard file delivery.

Try it and explore the source

Quick start · Source repository

Explore the underlying capabilities

All examples

How is this guide?

© 2026 DreamNum Co., Ltd.