環境変数と接続先
Orizm CLI の挙動と接続先は、環境変数で制御します。
環境変数の一覧
| 環境変数 | 用途 | 既定値 |
|---|---|---|
ORIZM_BASE_URL | Orizm API の接続先。ローカル・ステージング・本番を切り替えます。 | https://app.orizm.com |
ORIZM_OAUTH_ISSUER_URL | OAuth2 認証サーバーの URL。通常は ORIZM_BASE_URL と同じため省略します。 | ORIZM_BASE_URL と同じ |
ORIZM_API_KEY | Developer API キー。OAuth2 セッションが無いときに使われます。 | (未設定) |
ORIZM_PROJECT | 対象プロジェクト名。.orizm/project.json の代わりに使えます。 | (未設定) |
ORIZM_DEBUG | デバッグログを有効化します(--debug 相当)。 | (未設定) |
NO_COLOR | カラー出力を抑制します(--no-color 相当)。 | (未設定) |
認証への影響は 認証、プロジェクト指定は プロジェクトのリンク、ORIZM_DEBUG / NO_COLOR の挙動は 出力とスクリプティング を参照してください。
接続先を切り替える
接続先は ORIZM_BASE_URL で指定します。
# 本番(既定)
export ORIZM_BASE_URL=https://app.orizm.com
# ローカルの開発サーバー
export ORIZM_BASE_URL=http://localhost:4000OAuth2 認証サーバーは通常 ORIZM_BASE_URL と同じドメインのため、指定する必要はありません。ローカルで認証サーバーだけが別ポートで動いているなど、認証サーバーの URL が API と異なる場合にのみ ORIZM_OAUTH_ISSUER_URL を設定します。
export ORIZM_BASE_URL=http://localhost:4000
export ORIZM_OAUTH_ISSUER_URL=http://localhost:4444認証情報は接続先ごとに分けて保存されるため、接続先を切り替えると対応するセッションが自動的に選ばれます(接続先ごとのセッション)。
GitHub Actions での設定
CI では .orizm/project.json をコミットしない構成が一般的なため、認証と対象プロジェクトを環境変数で渡します。ジョブの env にまとめておくと、そのジョブ内のすべての orizm コマンドで共有できます。
.github/workflows/example.yml
jobs:
push-schema:
runs-on: ubuntu-latest
env:
ORIZM_API_KEY: ${{ secrets.ORIZM_API_KEY }}
ORIZM_PROJECT: my-project
steps:
- uses: actions/checkout@v4
# Node.js のセットアップと依存のインストールは省略
- run: pnpm exec orizm schema push --yesORIZM_API_KEYはリポジトリの Secrets に保存し、${{ secrets.ORIZM_API_KEY }}で参照します。ブラウザを開けない CI では、この API キー認証を使います(認証)。ORIZM_PROJECTで対象プロジェクトを指定します(プロジェクトのリンク)。- 本番以外(ステージングなど)に向ける場合は
ORIZM_BASE_URLを追加します。
.env ファイルについて
Orizm CLI は .env ファイルを自動では読み込みません。環境変数は、シェルで export するか、CI のジョブ定義で設定してください。
.env ファイルにまとめておきたい場合は、dotenv-cli や direnv などのラッパーを使います。
dotenv -e .env -- orizm schema pushLast updated on