Consumer CLI

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

generate

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

orizm-consumer generate <arg1> <arg2>

• 第1引数: 設定ファイルのパスを指定します
• 第2引数: 生成されるコードの出力先ディレクトリを指定します

orizm-consumer generate ./orizm.config.ts ./src/orizm

pull

プロジェクトの最新のスキーマ定義をもとに、クライアントコードとTypeScriptの型定義ファイルを生成します。

orizm-consumer pull <arg1>

• 第1引数: 生成されるコードの出力先ディレクトリを指定します

orizm-consumer pull ./src/orizm

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

—config <path>

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

orizm-consumer pull --env ./path/to/file ./src/orizm

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

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