CMS CLI

CMS CLIで利用可能なコマンドを説明します。

update

Orizmプロジェクトにスキーマを適用します。

orizm-cms update

このコマンドは以下の処理を行います。

1. 設定ファイル（デフォルトでは ./orizm.config.ts）からスキーマを読み込み
2. どのような変更が行われるか確認（意図しないものであればこの時点でキャンセル可能）
3. Orizmプロジェクトにスキーマを適用
4. クライアントコードとTypeScriptの型定義ファイルを生成

以下のオプションがあります。

—env <path>

環境変数ファイルのパスを指定します。デフォルトは .env.x.local です。

orizm-cms update --env ./path/to/file

環境変数ファイルは必須です。以下のように設定してください。<Orizmプロジェクト名> と <Developer API Key> はそれぞれプロジェクト名とAPIキーに置き換えてください。プロジェクト名とAPIキーは、プロジェクトの設定ページから取得できます。

ORIZM_BASE_URL=https://app.orizm.com
ORIZM_PROJECT=<Orizmプロジェクト名>
ORIZM_API_KEY=<Developer API Key>

—config <path>

設定ファイルのパスを指定します。デフォルトは ./orizm.config.ts です。

orizm-cms update --config ./path/to/file.ts

—output <path>

生成されるコードの出力先ディレクトリを指定します。デフォルトは ./src/orizm です。

orizm-cms update --output ./path/to/directory

—dry-run

実際にスキーマを適用することなく、どのような変更が行われるかを確認できます。

orizm-cms update --dry-run

-y, —yes

全てのプロンプトに対して yes で回答します。CI環境などインタラクティブな操作ができない場合に利用します。

orizm-cms update --yes

generate

クライアントコードとTypeScriptの型定義ファイルを生成します。

orizm-cms generate

以下のオプションがあります。

—config <path>

設定ファイルのパスを指定します。デフォルトは ./orizm.config.ts です。

orizm-cms update --config ./path/to/file.ts

—output <path>

生成されるコードの出力先ディレクトリを指定します。デフォルトは ./src/orizm です。

orizm-cms update --output ./path/to/directory