クイックスタート

インストール

プロジェクトに @orizm/cli を devDependency として追加します。

npm install --save-dev @orizm/cli

pnpm add --save-dev @orizm/cli

yarn add --dev @orizm/cli

bun add --dev @orizm/cli

以降の例では orizm を直接呼び出しますが、パッケージマネージャー経由なら pnpm exec orizm ... のように実行します。

接続先を確認する

既定の接続先は本番環境（https://app.orizm.com）です。ローカルやステージングのサーバーに向ける場合は ORIZM_BASE_URL を設定します。

export ORIZM_BASE_URL=http://localhost:4000

設定できる環境変数は 環境変数と接続先 を参照してください。

サインインする

ブラウザが開き、OAuth2 でサインインします。完了するとトークンがローカルに保存され、以降のコマンドで使われます。

orizm auth login

orizm auth status

orizm auth status で、誰として・どの接続先にサインインしているかを確認できます。

ディレクトリをプロジェクトにリンクする

組織とプロジェクトを対話的に選ぶと、.orizm/project.json が作成されます。以降のコマンドはこのプロジェクトを既定の対象にします。

orizm link

スキーマを適用する

orizm.config.ts にスキーマを定義し、サーバーに適用します。スキーマの書き方は スキーマ を参照してください。

適用前に差分を確認したいときは --dry-run を付けます。

orizm schema push --dry-run

差分を確認したら適用します。

orizm schema push

SDK の型を生成する

適用したスキーマから、CMS SDK / Consumer SDK 用の型コードを生成します。

orizm codegen cms
orizm codegen consumer