# CLI

> 使い慣れたエージェントにローカル Office 機能を追加。インストールしてサンプルを開き、計算・編集・レビューできる成果物を作ります。

- Human documentation: [https://docs.univer.ai/ja-JP/overview/examples/cli](https://docs.univer.ai/ja-JP/overview/examples/cli)

- Agent Markdown: [https://docs.univer.ai/ja-JP/overview/examples/cli.md](https://docs.univer.ai/ja-JP/overview/examples/cli.md)

- Requested language: `ja-JP`

- Content language: `ja-JP`

- Documentation version: `1.3.0`

- Source: [examples/cli.ja-JP.mdx](https://github.com/dream-num/documentation/blob/dev/content/docs/examples/cli.ja-JP.mdx)

---

**Univer CLI** は **[Univer Office SDK](https://docs.univer.ai/ja-JP/overview.md)** で構築されたローカル Office 自動化アプリです。既存のエージェントにコマンドと Skills を提供し、Excel・Word・PowerPoint の処理や、表、文書、プレゼンテーション、リレーショナルテーブル、キャンバスの作成を可能にします。成果物はローカルに保存されます。

**現在、Univer の操作は CLI（Command-Line Interface、コマンドラインインターフェース）が中心です**。従来の MCP を中心とした Agent 連携に代わり、Univer CLI が `univer` コマンドと Skills を提供します。Agent は自身のコマンド実行環境で編集・検査・成果物の受け渡しを行い、ローカル Viewer でプレビューとレビューを行えます。

[インストールと体験](#quick-start) · [Skills の仕組み](#skills) · [Skills 一覧](#skills-catalog)

## 使い慣れたエージェントで利用する

次のエージェントで Univer CLI を利用できます。

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

共通の入口は `univer` コマンドとバージョン対応の操作ガイドです。Agent Skills 対応ホストでは公式 Skill を読み込み、コマンド実行に対応したエージェントでは独自ツールから呼び出せます。対話内のプレビューカードなどは[連携プロジェクト](https://univer.ai/ecosystem)を参照してください。

## 最初の成果物を開く

Node.js 24 以降を用意し、エージェントが使う環境にインストールします。

```bash
npm install --global univer-cli@latest
npx skills add dream-num/skills -s univer-cli -g
univer doctor
```

`univer doctor` はローカル環境を確認します。Skill はコマンドの発見、製品別ガイドの読み込み、内容の検査と受け渡しを案内します。

### 公式サンプルを開く

新しい空のフォルダーで、エージェントに次を送ってください。

```text
Univer CLI で公式サンプルを試してください。
https://univer.ai/cli-assets/hello.univer を現在のフォルダーの hello.univer に保存してください。
内容を一覧にし、ローカル Viewer のリンクと試せる機能を教えてください。
```

既存の内容を開けば、すぐにネイティブエディターを体験できます。続いて修正を依頼するか、次の作成タスクを試してください。

## Skills：エージェント向け操作ガイド

Skills は、コンテンツモデル、編集手順、Facade API の検索方法、検証要件をエージェントが読めるガイドにまとめたものです。タスクに必要な機能を見つけ、編集からレビュー、成果物の受け渡しまで進めるために使います。

**検出用エントリー：** エージェントにインストールする [`univer-cli` Skill](https://github.com/dream-num/skills/blob/main/skills/univer-cli/SKILL.md) は Office タスクを認識し、ローカル CLI から完全なガイドを読み込むための入口です。

**ランタイム Skills：** CLI に同梱され、インストール済みバージョンのコマンドと Facade API に対応します。まず `core`、次に対象製品を読み込み、埋め込みやコンテンツ間数式を使う場合は対応するトピックを追加します。

### タスクに合わせて読み込む

通常はエージェントが読み込みますが、開発者も直接確認できます。

```bash
univer skills list
univer skills get core
univer skills get sheet
univer skills path sheet
```

`list` はインストール済み Skills の一覧、`get` はガイドの内容、`path` はローカルディレクトリを返します。参考資料やテンプレートも必要な場合は `univer skills get core --full` を使います。個別の API は `univer api find` と `univer api show` で必要に応じて調べます。

### Skills 一覧

名前をクリックするとソースのガイドを閲覧できます。実際のタスクでは、ローカルの `univer skills get <name>` が返すバージョンを使用してください。

| Skill | 用途 |
| --- | --- |
| [`core`](https://github.com/dream-num/univer-cli/blob/main/apps/cli/src/skills/runtime/core/SKILL.md) | 共通フロー：Unit と Worktree の理解、コンテンツの特定、編集、検証、レビューへの引き渡し。 |
| [`sheet`](https://github.com/dream-num/univer-cli/blob/main/apps/cli/src/skills/runtime/sheet/SKILL.md) | スプレッドシート（Sheet）：データ、数式、書式、グラフ、結果の検証。 |
| [`doc`](https://github.com/dream-num/univer-cli/blob/main/apps/cli/src/skills/runtime/doc/SKILL.md) | ドキュメント（Doc）：段落、リッチテキスト、表、グラフ、ページレイアウト。 |
| [`slide`](https://github.com/dream-num/univer-cli/blob/main/apps/cli/src/skills/runtime/slide/SKILL.md) | プレゼンテーション（Slide）：ページ、図形、テキスト、画像、表示の検証。 |
| [`base`](https://github.com/dream-num/univer-cli/blob/main/apps/cli/src/skills/runtime/base/SKILL.md) | Relational Table：テーブル、フィールド、レコード、ビュー。 |
| [`board`](https://github.com/dream-num/univer-cli/blob/main/apps/cli/src/skills/runtime/board/SKILL.md) | Canvases：キャンバス要素、グラフ、レイアウトの検証。 |
| [`embed`](https://github.com/dream-num/univer-cli/blob/main/apps/cli/src/skills/runtime/embed/SKILL.md) | 埋め込み：別の Unit のコンテンツを配置し、グラフのデータソースを接続。 |
| [`cross-unit-formula`](https://github.com/dream-num/univer-cli/blob/main/apps/cli/src/skills/runtime/cross-unit-formula/SKILL.md) | コンテンツ間数式：Sheet の範囲や Relational Table のフィールドを参照し、Sheet セルや数式を持つ図形で計算。 |

例えば、ドキュメントにスプレッドシートを埋め込む場合は `core → doc + sheet → embed` の順に読み込みます。Sheet セルや図形から別のコンテンツのデータを参照する場合は `cross-unit-formula` を追加します。最初から全ガイドを読み込む必要はありません。CLI の更新後は `core` と関連する製品・トピックの Skills を読み込み直してください。

## できること

- **データから成果物へ：** 表の整理、数式、グラフ、ピボットテーブルに加え、ヘッダー・フッター付きレポートや構成案からのプレゼンテーション作成に対応します。
- **内容をつなぐ：** 1 つの `.univer` ファイルに複数種類の内容を置き、数式、グラフの参照、埋め込みで関連付けられます。
- **作成後に検査：** Facade で実際のモデルを読み戻し、スクリーンショットやスライドのレイアウト検査で文字のはみ出し・重なり・ページ外配置を確認します。
- **レビューして受け渡す：** エージェントは独立した Worktree で編集し、ローカル Viewer のリンクを返します。差分確認、修正依頼、マージ、破棄、対応する Office 形式への出力ができます。キャンバスのファイル入出力には現在対応していません。

## こんなタスクを試す

> Univer CLI で日付、分類、金額と 5 行のサンプルを持つ月次支出表を作ってください。合計式と分類別グラフを加え、データと表示を検査して Viewer リンクを返してください。レビュー前にはマージしないでください。

## Office SDK が担う部分

Office SDK が Headless 実行環境、Facade API、計算、描画、バージョン、Worktree を提供します。CLI はそれらをコマンドとバージョン対応の Skills にまとめ、ローカルの `.univer` 保存、Gateway、Viewer を管理します。エージェントが作った内容をエディターで確認し、標準形式で受け渡せます。

## 体験とソースコード

[クイックスタート](https://github.com/dream-num/univer-cli#quick-start) · [ソースリポジトリ](https://github.com/dream-num/univer-cli)

## 関連する機能

- [ヘッドレス実行とサーバー側計算](https://docs.univer.ai/ja-JP/overview/features/shared/server-calculation.md)
- [ドキュメントの読み込みと内容操作](https://docs.univer.ai/ja-JP/ai/content-operations.md)
- [Worktree](https://docs.univer.ai/ja-JP/overview/features/shared/worktree.md)

[すべてのサンプル](https://docs.univer.ai/ja-JP/overview/examples.md)