パッケージ一覧
コンテンツ、共同編集、コンパイル、描画、プロセス、アプリケーションの用途別に AI SDK パッケージを選びます。
AI SDK は現在 25 個の独立したパッケージを公開しています。必要な基礎パッケージだけを入れ、同じ行のコマンドプリセットの標準操作が製品に合う場合に追加してください。
2 種類のパッケージの役割
| 役割 | 提供するもの |
|---|---|
| 基礎パッケージ | Commander に依存せず、コマンド名・出力・終了動作を決めない構造化 TypeScript API |
| コマンドプリセットパッケージ | 基礎パッケージを利用するネイティブ Commander Command。標準の引数、ヘルプ、端末操作を提供 |
コマンドプリセットの名前は通常 -command で終わります。すべての基礎パッケージにプリセットが必要なわけではありません。
コンテンツと共同編集のランタイム
| タスク | 基礎パッケージ | コマンドプリセットパッケージ |
|---|---|---|
| 標準のヘッドレス Univer を作成 | @univer-cli/headless-univer | — |
| Univer Facade API をオフライン検索 | @univer-cli/api-reference | @univer-cli/api-reference-command |
| Facade 実行の準備とバインド | @univer-cli/content-execution | — |
| Sheet、Doc、Slide の内容を読む | @univer-cli/content-inspection | @univer-cli/content-inspection-command |
| 1 つの共同編集 Unit を実行 | @univer-cli/univer-collaboration-runtime | — |
| Worker で共同編集ランタイムを再利用 | @univer-cli/univer-collaboration-runtime-pool | — |
コンテンツのコンパイル
| タスク | 基礎パッケージ | コマンドプリセットパッケージ |
|---|---|---|
| SVG を Slide Facade コードに変換 | @univer-cli/svg-facade | @univer-cli/svg-facade-command |
| Typst バンドルを Doc Facade コードに変換 | @univer-cli/doc-typst-facade | @univer-cli/doc-typst-facade-command |
レンダリングと診断
| タスク | 基礎パッケージ | コマンドプリセットパッケージ |
|---|---|---|
| Unit の PNG を撮影 | @univer-cli/unit-screenshot | @univer-cli/unit-screenshot-command |
| Slide レイアウトを検査 | @univer-cli/unit-layout-lint | @univer-cli/unit-layout-lint-command |
| Render Page の提供とブラウザー操作 | @univer-cli/univer-render-runtime | — |
| Render Page を構成・ビルド | @univer-cli/univer-render-page | — |
プロセスとライフサイクル
| タスク | 基礎パッケージ | コマンドプリセットパッケージ |
|---|---|---|
| キーごとに状態を持つオブジェクトを排他的に取得・キャッシュ・破棄 | @univer-cli/generic-keyed-instance-pool | — |
| 複数の CLI プロセスからローカル常駐プロセスへアクセス | @univer-cli/daemon | @univer-cli/daemon-command |
アプリケーション補助
| タスク | 基礎パッケージ | コマンドプリセットパッケージ |
|---|---|---|
| アプリケーション設定の宣言・読み取り・保存 | @univer-cli/config | @univer-cli/config-command |
| 視覚リソースの検索・キャッシュ・出力 | @univer-cli/resource-library | @univer-cli/resource-library-command |
選び方
- 業務の目的に合う基礎パッケージから始めます。
- 標準の Commander 操作が製品に合う場合だけプリセットを追加します。
- CLI、Web、Server が Unit を共有する場合は、データベースに直接アクセスせず共同編集ランタイムを使います。
- 再利用、プロセス間アクセス、ブラウザー描画が必要になってからプール、Daemon、Render Runtime を追加します。
- 対象パッケージの README で公開 API、所有権、破棄動作を確認します。
概念と基本的な使い方はドキュメントの読み込みと操作、視覚的検査、ランタイム再利用と Daemonを参照してください。
このガイドはいかがですか？