CLI移行ガイド

このガイドでは @orizm/cms-sdk や @orizm/consumer-sdk に同梱されている CLI から @orizm/cli に移行する方法を説明します。

新しいCLIのインストール

npm install @orizm/cli --save-dev

pnpm add @orizm/cli --save-dev

yarn add @orizm/cli --dev

bun add @orizm/cli --dev

@orizm/cli については、CLI を参照してください。

破壊的変更

コマンドの変更

CLI のコマンドは以下のように変更されました。

orizm-cms update コマンド

orizm-cms update コマンドは、CMS のデータを Orizm にプッシュするためのコマンドでした。このコマンドは orizm push コマンドに置き換えられました。

新しい push コマンドでは以下のように挙動が変更されます。

• これまでの orizm-cms update コマンドでは、プロジェクトへスキーマを適用するとともに、CMS向けのクライアントや型定義のコード生成を行っていました。
• 新しい orizm push コマンドでは、Orizmプロジェクトへスキーマを適用することに特化し、CMS向けのクライアントや型定義のコード生成は行いません。
• CMS向けのクライアントや型定義のコード生成を行う場合は、orizm cms generate コマンドを使用する必要があります。

例えば、これまで npm-scripts で以下のように orizm-cms update コマンドを実行していた場合、

{
  "scripts": {
    "orizm:update": "orizm-cms update"
  }
}

これをこれまでと同じ挙動に保ちたい場合は、以下のように変更します。

{
  "scripts": {
    "orizm:update": "orizm push && orizm cms generate"
  }
}

orizm-consumer pull コマンド

orizm-consumer pull コマンドは、プロジェクトの最新のスキーマをもとに、Consumer向けのクライアントや型定義を生成するためのコマンドでした。 このコマンドは orizm consumer pull コマンドに置き換えられました。

新しい orizm consumer pull コマンドでは、以下のように挙動が変更されます。

• これまでは環境変数 ORIZM_CONSUMER_KEY に Consumer APIキーを指定する必要がありました。
• 新しい orizm consumer pull コマンドでは環境変数 ORIZM_CONSUMER_KEY の代わりに、 ORIZM_API_KEY に Developer APIキー を指定します。

環境変数ファイルのデフォルトパス

これまでSDK同梱のCLIでは以下のように、環境変数ファイルのデフォルトパスが決まっていました。

新しいCLIでは、./.env がデフォルトパスになります。