Supabase CLIのインストール、ローカル環境の起動、プロジェクトのリンク、マイグレーションのプッシュ、型の生成、Edge Functionsのデプロイを、検索できる主要コマンド表とともに解説します。
Supabase CLIは、自分のパソコンでSupabaseのコピーを動かし、データベースの変更を本番のプロジェクトに反映するコマンドラインプログラムです。Homebrew、Scoop、npmでインストールし、supabase initとsupabase startを実行したら、supabase linkとsupabase db pushでマイグレーションをホスティング先のプロジェクトに送ります。
Supabase CLIのインストール方法
コマンドの一部やtypesのような単語を入力するか、グループを選ぶと、下の表を絞り込めます。各行は公式のCLIリファレンスにあるコマンドで、サイト運営者がどんなときに使うかの短い説明を付けています。
ローカル環境には必要です。または別のコンテナランタイムでも構いません。ガイドでは代替としてOrbStack、Rancher Desktop、Podman、colimaを挙げており、LinuxとAppleシリコン搭載Mac向けの実験的なネイティブランタイムにも触れています。
公式ガイドによると、npmパッケージはCLIをグローバルコマンドではなく単一のプロジェクトに追加します。システム全体にインストールするにはHomebrewかScoopを使いましょう。
db pushは、ローカルのマイグレーションファイルをデータベースに送ります。db pullは、リモートデータベースのスキーマを読み取って新しいマイグレーションファイルに書き出します。ダッシュボードで変更を加えた場合に便利です。
supabase gen types --lang typescriptを、ローカルのデータベースなら--local、ホスティング先なら--linkedを付けて実行し、出力をプロジェクト内のファイルにリダイレクトします。
supabase functions newに名前を付けて作成し、その名前でsupabase functions deployを実行します。シークレットはsupabase secrets set NAME=VALUEで設定します。
プロジェクトのフォルダーで実行してください。リファレンスIDは、プロジェクトの設定にあるものに置き換えます。
順番が重要です。マイグレーションを作成し、ローカルでリセットして確認してから、プッシュします。
コマンドを検索
push、types、functions...
グループ
すべて
セットアップ
ローカル環境
データベース
型
Edge Functions
コマンド
機能
{n}件のコマンドを表示中
一致するコマンドはありません。検索をクリアするとすべて表示されます。
ブラウザー、または--tokenでCLIをSupabaseアカウントにログインさせます。
現在のプロジェクトにsupabaseフォルダーと設定ファイルを作成します。
コンテナでローカル環境を起動し、ローカルのURLとキーを表示します。
ローカル環境を停止します。--no-backupを付けるとローカルのデータを破棄します。
ローカルのURLとキーを再表示します。-o envを付けると環境変数の形式で出力します。
変更用に、supabase/migrationsにタイムスタンプ付きの空のSQLファイルを作成します。
マイグレーションからローカルのデータベースを再構築し、シードファイルを実行します。
新しいローカルのマイグレーションをリンク先のデータベースに適用します。まず--dry-runを試しましょう。
リモートのスキーマを新しいマイグレーションファイルに書き出します。Dockerデーモンの起動が必要です。
スキーマを比較し、-fで差分をマイグレーションとして保存します。
テーブルのTypeScript型を書き出します。ローカルのデータベースには--localを使います。
スターターコード付きの新しいEdge Functionフォルダーを作成します。
テスト中にEdge Functionsをローカルで実行します。
Edge Functionをホスティング先のプロジェクトにアップロードします。
決済キーなどのシークレットを、ホスティング先のEdge Functions用に保存します。
無料で始める · クレジットカード不要