2 min
Package catalog
Select every Univer CLI SDK package by content, collaboration, compilation, rendering, process, and application task.
Univer CLI SDK currently publishes 25 independent packages. Install only the base packages the application needs, then add a command preset from the same row when its default terminal interaction fits the product.
Two package roles
| Role | Provides |
|---|---|
| Base package | Structured TypeScript APIs without depending on Commander or deciding command names, output, and exit behavior |
| Command preset package | A native Commander Command backed by a base package, with default arguments, help, and terminal interaction |
Command presets usually end in -command. Not every base package needs a corresponding command preset.
Content and collaboration runtimes
| Task | Base package | Command preset package |
|---|---|---|
| Create standard headless Univer | @univer-cli/headless-univer | — |
| Search the Univer Facade API offline | @univer-cli/api-reference | @univer-cli/api-reference-command |
| Prepare and bind Facade execution | @univer-cli/content-execution | — |
| Read Sheet, Doc, or Slide content | @univer-cli/content-inspection | @univer-cli/content-inspection-command |
| Run one collaborative Unit | @univer-cli/univer-collaboration-runtime | — |
| Reuse collaboration runtimes in workers | @univer-cli/univer-collaboration-runtime-pool | — |
Content compilation
| Task | Base package | Command preset package |
|---|---|---|
| Convert SVG into Slide Facade code | @univer-cli/svg-facade | @univer-cli/svg-facade-command |
| Convert a Typst bundle into Doc Facade code | @univer-cli/doc-typst-facade | @univer-cli/doc-typst-facade-command |
Rendering and diagnostics
| Task | Base package | Command preset package |
|---|---|---|
| Capture a Unit PNG | @univer-cli/unit-screenshot | @univer-cli/unit-screenshot-command |
| Lint Slide layout | @univer-cli/unit-layout-lint | @univer-cli/unit-layout-lint-command |
| Host a Render Page and drive a browser | @univer-cli/univer-render-runtime | — |
| Compose and build a Render Page | @univer-cli/univer-render-page | — |
Processes and lifecycle
| Task | Base package | Command preset package |
|---|---|---|
| Exclusively acquire, cache, and retire stateful objects by key | @univer-cli/generic-keyed-instance-pool | — |
| Let multiple CLI processes access one local resident process | @univer-cli/daemon | @univer-cli/daemon-command |
Application helpers
| Task | Base package | Command preset package |
|---|---|---|
| Declare, read, and persist application configuration | @univer-cli/config | @univer-cli/config-command |
| Query, cache, and export visual resources | @univer-cli/resource-library | @univer-cli/resource-library-command |
How to choose
- Start with the base package that matches the business task.
- Add its command preset only when the default Commander interaction fits the product.
- Use a collaboration runtime when the CLI, Web, and Server share a Unit instead of accessing the collaboration database directly.
- Add a pool, daemon, or Render Runtime only when the application needs reuse, cross-process access, or browser rendering.
- Read the target package README for its public APIs, ownership, and disposal behavior.
See Document loading and content operations, Visual inspection, and Runtime reuse and Daemon for concepts and core usage.