@orizm/cli 3.1.0 → 3.3.0-beta.0

package/dist/docs/features/cli/commands/content.md

@@ -0,0 +1,117 @@
+<!-- source: docs/src/app/features/cli/commands/content/page.mdx -->
+
+# content — コンテンツ
+
+テーブルのコンテンツを操作します。テーブル名は `orizm.config.ts` で定義したものです。
+
+> [!NOTE]
+> すべて認証とプロジェクトコンテキストが必要です。コンテンツのスキーマはテーブルごとに異なるため、出力は整形した JSON で表示されます。
+
+## `orizm content list`
+
+テーブルのコンテンツ一覧を取得します。
+
+```sh copy
+orizm content list <table> [--filter <json>] [--order <json>] [--limit <n>] [--offset <n>]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<table>` | テーブル名。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--filter <json>` | フィルター式を JSON 文字列で指定します。 |
+| `--order <json>` | 並び順を JSON 文字列（オブジェクトまたは配列）で指定します。 |
+| `--limit <n>` | 取得件数。既定は `100`。 |
+| `--offset <n>` | ページネーションのオフセット。既定は `0`。 |
+
+```sh copy
+orizm content list article --filter '{"status":{"eq":"published"}}' --limit 20
+```
+
+## `orizm content get`
+
+特定のコンテンツを取得します。
+
+```sh copy
+orizm content get <table> <id>
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<table>` | テーブル名。 |
+| `<id>` | コンテンツ ID。 |
+
+## `orizm content create`
+
+コンテンツを作成します。
+
+```sh copy
+orizm content create <table> --data <json>
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<table>` | テーブル名。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--data <json>` | （必須）コンテンツの各フィールド。JSON 文字列、または `@path/to/file.json` でファイルを指定します。 |
+
+```sh copy
+orizm content create article --data '{"title":"Hello","body":"..."}'
+orizm content create article --data @./article.json
+```
+
+## `orizm content update`
+
+コンテンツを更新します。
+
+```sh copy
+orizm content update <table> <id> --data <json>
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<table>` | テーブル名。 |
+| `<id>` | コンテンツ ID。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--data <json>` | （必須）更新する各フィールド。JSON 文字列、または `@path/to/file.json`。 |
+
+## `orizm content delete`
+
+コンテンツを削除します。
+
+```sh copy
+orizm content delete <table> <id> [--yes]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<table>` | テーブル名。 |
+| `<id>` | コンテンツ ID。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--yes` | 確認プロンプトをスキップします。 |

package/dist/docs/features/cli/commands/key.md

@@ -0,0 +1,155 @@
+<!-- source: docs/src/app/features/cli/commands/key/page.mdx -->
+
+# key — APIキー
+
+プロジェクトの APIキーを管理します。公開読み取り用の **Consumer Key** と、RBAC を伴うコンテンツ操作用の **Management Key** の 2 種類があります。
+
+> [!NOTE]
+> すべて認証とプロジェクトコンテキストが必要です。
+
+> [!WARNING]
+> Orizm の APIキーは発行後もいつでも平文を参照できますが、画面共有やログへの露出事故を防ぐため、CLI はキーを含む出力を既定でマスクします（`x_consumer_****` のような表示）。`--show-key` を付けたときだけ平文で表示します（`--json` 出力にも適用されます）。
+
+## Consumer Key
+
+### `orizm key consumer list`
+
+Consumer Key の一覧を表示します。
+
+```sh copy
+orizm key consumer list [--show-key]
+```
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--show-key` | キーをマスクせず平文で表示します。 |
+
+### `orizm key consumer create`
+
+Consumer Key を新規発行します。
+
+```sh copy
+orizm key consumer create --description <s> [--can-read-drafts] [--show-key]
+```
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--description <s>` | （必須）キーの用途説明。 |
+| `--can-read-drafts` | 下書きコンテンツの読み取りを許可します。 |
+| `--show-key` | 発行したキーを平文で表示します。 |
+
+### `orizm key consumer delete`
+
+Consumer Key を失効させます。
+
+```sh copy
+orizm key consumer delete <id> [--yes]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<id>` | Consumer Key の数値 ID。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--yes` | 確認プロンプトをスキップします。 |
+
+## Management Key
+
+### `orizm key management list`
+
+Management Key の一覧を表示します。
+
+```sh copy
+orizm key management list [--show-key]
+```
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--show-key` | キーをマスクせず平文で表示します。 |
+
+### `orizm key management create`
+
+Management Key を新規発行します。Group / Role の付与は `update` で行います。
+
+```sh copy
+orizm key management create --description <s> [--show-key]
+```
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--description <s>` | （必須）キーの用途説明。 |
+| `--show-key` | 発行したキーを平文で表示します。 |
+
+### `orizm key management update`
+
+説明や Group / Role を更新します。
+
+```sh copy
+orizm key management update <id> [--description <s>] [--group-role <g>:<r>] [--add-group-role <g>:<r>] [--remove-group-role <g>] [--clear-group-roles] [--show-key]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<id>` | Management Key の数値 ID。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--description <s>` | 用途説明を変更します。 |
+| `--group-role <g>:<r>` | RBAC を全置換します（複数指定可）。 |
+| `--add-group-role <g>:<r>` | RBAC を追加します。同じ group は role を置き換えます（複数指定可）。 |
+| `--remove-group-role <g>` | group 名を指定して RBAC を削除します（複数指定可）。 |
+| `--clear-group-roles` | RBAC をすべて削除します。 |
+| `--show-key` | 結果表示でキーをマスクしません。 |
+
+Group / Role の編集方式については [Group / Role の編集](#group--role-の編集) を参照してください。
+
+```sh copy
+orizm key management update 12 --add-group-role editors:writer --add-group-role admins:owner
+```
+
+### `orizm key management delete`
+
+Management Key を失効させます。
+
+```sh copy
+orizm key management delete <id> [--yes]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<id>` | Management Key の数値 ID。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--yes` | 確認プロンプトをスキップします。 |
+
+## Group / Role の編集
+
+API は `groupRoles` を配列の全置換でしか受け付けませんが、CLI では要素単位の編集オプションを提供します。
+
+- **全置換** — `--group-role <g>:<r>`（複数指定可）。指定した内容で丸ごと置き換えます。
+- **追加 / 削除** — `--add-group-role <g>:<r>` / `--remove-group-role <g>`。現在の値を取得してから編集して送ります。同じ group には複数の role を持てないため、`--add-group-role` は既存の role を置き換えます。
+- **全削除** — `--clear-group-roles`。
+
+全置換系（`--group-role` / `--clear-group-roles`）と編集系（`--add-group-role` / `--remove-group-role`）は同時に指定できません。存在しない group の削除は無視されますが、タイポに気づけるよう通知が出ます。

package/dist/docs/features/cli/commands/link.md

@@ -0,0 +1,21 @@
+<!-- source: docs/src/app/features/cli/commands/link/page.mdx -->
+
+# link — プロジェクトのリンク
+
+作業ディレクトリを操作対象のプロジェクトに結び付けます。仕組みの詳細は [プロジェクトのリンク](../project-linking.md) を参照してください。
+
+## `orizm link`
+
+2 ステップの対話で組織とプロジェクトを選び、`.orizm/project.json` を作成・更新します。
+
+```sh copy
+orizm link
+```
+
+1. 所属する組織を選びます。
+2. その組織のプロジェクトを選びます。
+
+選択結果が `.orizm/project.json` に書き込まれます。初回リンク時は、`.gitignore` への `.orizm/` の追記を提案します。
+
+> [!NOTE]
+> `orizm link` は対話的な選択が必要なため、ターミナル（TTY）が必要です。認証も必要です（組織・プロジェクトの一覧を取得するため）。CI など非対話環境では、`ORIZM_PROJECT` または `--project` でプロジェクトを指定してください。

package/dist/docs/features/cli/commands/org.md

@@ -0,0 +1,18 @@
+<!-- source: docs/src/app/features/cli/commands/org/page.mdx -->
+
+# org — 組織
+
+所属する組織を参照します。組織自体の作成・メンバー管理は Orizm Console で行います。
+
+> [!NOTE]
+> `org` のコマンドは認証を必要としますが、プロジェクトコンテキストは必要としません。
+
+## `orizm org list`
+
+サインインしているユーザーが所属する組織の一覧（名前・表示名・ID）を表示します。
+
+```sh copy
+orizm org list
+```
+
+`orizm project list` や `orizm project create` で組織名を指定するときの参照に使えます。

package/dist/docs/features/cli/commands/project-user.md

@@ -0,0 +1,108 @@
+<!-- source: docs/src/app/features/cli/commands/project-user/page.mdx -->
+
+# project-user — プロジェクトユーザー
+
+プロジェクトユーザー（CMS 側のエンドユーザー）と、その RBAC を管理します。開発者自身のアカウント管理は対象外で、Orizm Console で行います。
+
+> [!NOTE]
+> すべて認証とプロジェクトコンテキストが必要です。
+
+## `orizm project-user list`
+
+プロジェクトユーザーの一覧を表示します。
+
+```sh copy
+orizm project-user list [--limit <n>] [--offset <n>]
+```
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--limit <n>` | 取得件数（`50` / `100` / `200`）。既定は `50`。 |
+| `--offset <n>` | ページネーションのオフセット。既定は `0`。 |
+
+## `orizm project-user get`
+
+特定のプロジェクトユーザーの詳細を表示します。
+
+```sh copy
+orizm project-user get <user-id>
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<user-id>` | プロジェクトユーザーの ID。 |
+
+## `orizm project-user invite`
+
+ユーザーをメールで招待します。
+
+```sh copy
+orizm project-user invite <email> [--name <s>] [--group-role <g>:<r>]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<email>` | 招待するメールアドレス。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--name <s>` | 表示名。 |
+| `--group-role <g>:<r>` | 招待時に付与する RBAC（複数指定可）。 |
+
+```sh copy
+orizm project-user invite alice@example.com --name Alice --group-role editors:writer
+```
+
+## `orizm project-user update`
+
+表示名や Group / Role を更新します。
+
+```sh copy
+orizm project-user update <user-id> [--name <s>] [--group-role <g>:<r>] [--add-group-role <g>:<r>] [--remove-group-role <g>] [--clear-group-roles]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<user-id>` | プロジェクトユーザーの ID。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--name <s>` | 表示名を変更します。 |
+| `--group-role <g>:<r>` | RBAC を全置換します（複数指定可）。 |
+| `--add-group-role <g>:<r>` | RBAC を追加します。同じ group は role を置き換えます（複数指定可）。 |
+| `--remove-group-role <g>` | group 名を指定して RBAC を削除します（複数指定可）。 |
+| `--clear-group-roles` | RBAC をすべて削除します。 |
+
+Group / Role の編集方式は [key management の Group / Role の編集](./key.md#group--role-の編集) と同じです。全置換系と編集系は同時に指定できません。
+
+## `orizm project-user delete`
+
+プロジェクトユーザーを削除します。プロジェクトユーザーはプロジェクトごとに管理されるため、削除するとそのユーザーは対象プロジェクトから完全に取り除かれ、サインインできなくなります。
+
+```sh copy
+orizm project-user delete <user-id> [--yes]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<user-id>` | プロジェクトユーザーの ID。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--yes` | 確認プロンプトをスキップします。 |

package/dist/docs/features/cli/commands/project.md

@@ -0,0 +1,106 @@
+<!-- source: docs/src/app/features/cli/commands/project/page.mdx -->
+
+# project — プロジェクト
+
+プロジェクトの作成・参照・更新・削除を行います。
+
+> [!NOTE]
+> すべて認証が必要です。`list` と `create` は[組織](../project-linking.md#組織の解決順序)を、`get` / `update` / `delete` は[プロジェクト](../project-linking.md#プロジェクトの解決順序)を対象にします。
+
+## `orizm project list`
+
+組織内のプロジェクト一覧を表示します。
+
+```sh copy
+orizm project list [--organization <name>]
+```
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--organization <name>` | 対象の組織名。省略時は `.orizm/project.json` の `organizationName` を使います。 |
+
+## `orizm project get`
+
+プロジェクトの詳細を表示します。
+
+```sh copy
+orizm project get [<name>]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<name>` | プロジェクト名。省略時は現在のプロジェクトコンテキストを使います。 |
+
+## `orizm project create`
+
+プロジェクトを作成します。プロジェクト名は Orizm 全体で一意である必要があります。
+
+```sh copy
+orizm project create <name> [--organization <name>] [--display-name <s>]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<name>` | 新しいプロジェクト名（一意）。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--organization <name>` | 作成先の組織名。省略時は `.orizm/project.json` の `organizationName` を使います。 |
+| `--display-name <s>` | 表示名。省略時はプロジェクト名と同じになります。 |
+
+```sh copy
+orizm project create my-project --organization my-organization --display-name "My Project"
+```
+
+## `orizm project update`
+
+プロジェクトの設定を更新します。指定したオプションの項目だけが変更されます。
+
+```sh copy
+orizm project update [<name>] [--display-name <s>] [--cms-url <url>] [--deletion-protected <true|false>]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<name>` | プロジェクト名。省略時は現在のプロジェクトコンテキストを使います。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--display-name <s>` | 表示名を変更します。 |
+| `--cms-url <url>` | CMS の URL を変更します。 |
+| `--deletion-protected <value>` | 削除保護を `true` / `false` で設定します。 |
+
+## `orizm project delete`
+
+プロジェクトを削除します。配下のコンテンツごと失われる破壊的な操作です。
+
+```sh copy
+orizm project delete [<name>] [--yes]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<name>` | プロジェクト名。省略時は現在のプロジェクトコンテキストを使います。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--yes` | 確認入力をスキップします（CI 向け）。 |
+
+> [!WARNING]
+> ターミナルでは、確認のためにプロジェクト名の入力を求められます。入力が一致したときだけ削除します。非対話環境では `--yes` が必要です。

package/dist/docs/features/cli/commands/schema.md

@@ -0,0 +1,108 @@
+<!-- source: docs/src/app/features/cli/commands/schema/page.mdx -->
+
+# schema — スキーマ定義
+
+`orizm.config.ts` のスキーマをサーバーに適用したり、定義を参照・検証したりします。スキーマの書き方は [スキーマ](../../schema/about.md) を参照してください。
+
+> [!NOTE]
+> `push` / `list` / `get` は認証とプロジェクトコンテキストが必要です。`validate` / `erd` はローカルで完結するため、どちらも必要ありません。
+
+## `orizm schema push`
+
+`orizm.config.ts` を読み込んで、スキーマをプロジェクトに適用します。
+
+```sh copy
+orizm schema push [<config-file>] [--dry-run] [--yes] [--force]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<config-file>` | 設定ファイルのパス。省略時は `./orizm.config.ts`。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--dry-run` | 適用せず、変更内容だけを表示します。 |
+| `--yes` | 確認プロンプトをスキップして適用します（CI 向け）。 |
+| `--force` | 変更が無くても定義を送り、サーバー側の突き合わせ（セマンティック検索のベクトルインデックスの再構築など）を再実行させます。`--dry-run` には影響しません。 |
+
+適用前には変更内容が表示されます。`--dry-run` でも `--yes` でもないときは、ターミナルで確認プロンプトを出し、承認したときだけ適用します。非対話環境では `--yes` が必要です。変更が無いときは `--force` を付けない限り何もしません。
+
+```sh copy
+# 変更内容を確認する
+orizm schema push --dry-run
+
+# 確認なしで適用する（CI 向け）
+orizm schema push --yes
+```
+
+## `orizm schema list`
+
+スキーマ定義のバージョン一覧を表示します。
+
+```sh copy
+orizm schema list [--status <status>] [--limit <n>] [--offset <n>]
+```
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--status <status>` | `pending` / `failed` / `success` で絞り込みます（複数指定可）。 |
+| `--limit <n>` | 取得件数（`50` / `100` / `200`）。既定は `50`。 |
+| `--offset <n>` | ページネーションのオフセット。既定は `0`。 |
+
+```sh copy
+orizm schema list --status success --limit 100
+```
+
+## `orizm schema get`
+
+特定のバージョンのスキーマ定義を表示します。
+
+```sh copy
+orizm schema get <definition-id>
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<definition-id>` | スキーマ定義の数値 ID。 |
+
+## `orizm schema validate`
+
+`orizm.config.ts` をローカルで検証します。サーバーへの通信は行いません。
+
+```sh copy
+orizm schema validate [<config-file>]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<config-file>` | 設定ファイルのパス。省略時は `./orizm.config.ts`。 |
+
+## `orizm schema erd`
+
+`orizm.config.ts` から ERD（Mermaid 形式）を生成します。サーバーへの通信は行いません。
+
+```sh copy
+orizm schema erd [<config-file>] [--output <path>]
+```
+
+**引数**
+
+| 引数 | 説明 |
+| --- | --- |
+| `<config-file>` | 設定ファイルのパス。省略時は `./orizm.config.ts`。 |
+
+**オプション**
+
+| オプション | 説明 |
+| --- | --- |
+| `--output <path>`, `-o` | 出力先ファイル。省略時は標準出力に書き出します。 |