Skip to Content
FeaturesCLIOrizm CLI

Orizm CLI

Orizm CLI（orizm）は、Orizm のプロジェクトをターミナルから操作する開発者向けのコマンドラインツールです。スキーマの適用、SDK の型生成、コンテンツ・APIキー・ユーザー・バケット・Webhook の管理までを、ひとつのコマンドで扱えます。

npm install --save-dev @orizm/cli

インストールすると orizm コマンドが使えます。パッケージマネージャー経由で実行する場合は pnpm exec orizm ... や npx orizm ... のように呼び出します。

v2 から移行する場合は、コマンド体系と認証方式が変わっています。CLI移行ガイド (v2→v3) を参照してください。

基本的な流れ

Orizm CLI は「認証する → ディレクトリをプロジェクトにリンクする → 操作する」の 3 ステップで使います。

  1. 認証 — orizm auth login でブラウザからサインインします。CI など自動化環境では ORIZM_API_KEY を使います。詳しくは 認証 を参照してください。
  2. リンク — orizm link で、作業ディレクトリを操作対象のプロジェクトに結び付けます。以降のコマンドはこのプロジェクトを既定の対象にします。詳しくは プロジェクトのリンク を参照してください。
  3. 操作 — orizm schema push や orizm content list など、目的のコマンドを実行します。

はじめて使うときは クイックスタート が最短経路です。

コマンドの全体像

コマンドは orizm <名詞> <動詞> の形に統一されています（例: orizm schema push、orizm key consumer list）。各カテゴリーの詳細は コマンドリファレンス を参照してください。

カテゴリーコマンド用途
authorizm auth login / logout / statusサインインとセッション確認
linkorizm linkディレクトリとプロジェクトの結び付け
orgorizm org list所属組織の一覧
projectorizm project list / get / create / update / deleteプロジェクトのライフサイクル
schemaorizm schema push / list / get / validate / erdスキーマ定義の適用と参照
codegenorizm codegen cms / consumerSDK 型コードの生成
keyorizm key consumer ... / orizm key management ...APIキーの管理
project-userorizm project-user ...プロジェクトユーザー（RBAC）の管理
contentorizm content list / get / create / update / deleteテーブルコンテンツの操作
bucketorizm bucket list / orizm bucket object ...バケットとオブジェクトの操作
webhookorizm webhook list / get / create / update / deleteWebhook の管理

グローバルフラグ

すべてのコマンドで次のフラグが使えます。

フラグ説明
--json結果を機械可読な JSON で標準出力に出します。
--debugデバッグログを標準エラー出力に出します（環境変数 ORIZM_DEBUG でも有効化できます）。
--no-colorカラー出力を抑制します（環境変数 NO_COLOR も尊重します）。

プロジェクトを対象とするコマンドでは、対象を一時的に切り替える --project <name> も使えます。出力の扱いやスクリプトでの利用については 出力とスクリプティング を参照してください。

Last updated on
v2への移行手順クイックスタート