Supabae CLIのコマンドリストをまとめてみました。
バージョン
v2.33.9
- 環境立ち上げ
- テーブルマイグレーション(RLS設定)
- 認証設定
https://supabase.com/
実際に環境を立ち上げて、手を動かしながら進めることをお勧めします。
基本的なコマンド
コマンド |
説明 |
用途 |
supabase status |
ローカル Supabase の状態を確認 |
ローカル環境の起動状況、URL、キー情報を表示 |
supabase start |
ローカル Supabase を起動 |
開発環境の Supabase を開始 |
supabase stop |
ローカル Supabase を停止 |
開発環境の Supabase を停止 |
supabase restart |
ローカル Supabase を再起動 |
設定変更後の環境再起動 |
supabase db reset |
ローカルデータベースをリセット |
ローカル DB を再作成し、全マイグレーションを適用 |
マイグレーション関連
コマンド |
説明 |
用途 |
supabase migration list |
マイグレーション一覧を表示 |
ローカルとリモートのマイグレーション状況を比較 |
supabase db push |
ローカルマイグレーションをリモートに適用 |
ローカルのマイグレーションファイルをリモート DB に適用 |
supabase db pull |
リモートスキーマをローカルに同期 |
リモート DB の最新スキーマをローカルに反映 |
supabase db diff |
スキーマの差分を確認 |
ローカルとリモートのスキーマ差分を表示 |
supabase migration new |
新しいマイグレーションファイルを作成 |
スキーマ変更用のマイグレーションファイルを生成 |
supabase migration up |
保留中のマイグレーションを適用 |
未適用のマイグレーションをローカル DB に適用 |
supabase migration down |
マイグレーションをロールバック |
最後のマイグレーションを取り消し |
プロジェクト管理
コマンド |
説明 |
用途 |
supabase init |
新しい Supabase プロジェクトを初期化 |
プロジェクトの初期設定 |
supabase link --project-ref |
リモートプロジェクトとリンク |
ローカルとリモートプロジェクトを接続 |
supabase unlink |
リモートプロジェクトとのリンクを解除 |
プロジェクトのリンクを削除 |
supabase projects list |
プロジェクト一覧を表示 |
利用可能なプロジェクトを確認 |
データベース操作
コマンド |
説明 |
用途 |
supabase db dump |
データベースのダンプを作成 |
バックアップやデータ移行用の SQL ファイル生成 |
supabase db restore |
データベースを復元 |
ダンプファイルからデータベースを復元 |
supabase db seed |
シードデータを実行 |
テストデータや初期データを投入 |
supabase db lint |
SQL ファイルの構文チェック |
マイグレーションファイルの文法エラーを検出 |
認証・セキュリティ
コマンド |
説明 |
用途 |
supabase auth list |
認証設定を一覧表示 |
現在の認証設定を確認 |
supabase auth config |
認証設定を変更 |
認証プロバイダーの設定を更新 |
supabase secrets list |
シークレット一覧を表示 |
環境変数やシークレットの確認 |
supabase secrets set |
シークレットを設定 |
新しいシークレットを追加 |
supabase secrets unset |
シークレットを削除 |
不要なシークレットを削除 |
ストレージ管理
コマンド |
説明 |
用途 |
supabase storage list |
ストレージバケット一覧を表示 |
利用可能なストレージバケットを確認 |
supabase storage create |
新しいストレージバケットを作成 |
ファイル保存用のバケットを追加 |
supabase storage delete |
ストレージバケットを削除 |
不要なバケットを削除 |
supabase storage upload |
ファイルをアップロード |
ローカルファイルをストレージにアップロード |
supabase storage download |
ファイルをダウンロード |
ストレージからファイルをダウンロード |
エッジ関数
コマンド |
説明 |
用途 |
supabase functions list |
エッジ関数一覧を表示 |
デプロイ済みの関数を確認 |
supabase functions new |
新しいエッジ関数を作成 |
サーバーレス関数のテンプレートを生成 |
supabase functions serve |
エッジ関数をローカルで実行 |
開発中の関数をローカルでテスト |
supabase functions deploy |
エッジ関数をデプロイ |
関数を本番環境にデプロイ |
supabase functions delete |
エッジ関数を削除 |
不要な関数を削除 |
ログ・デバッグ
コマンド |
説明 |
用途 |
supabase logs |
ログを表示 |
アプリケーションのログを確認 |
supabase logs --follow |
リアルタイムログを表示 |
ログをリアルタイムで監視 |
supabase logs --level |
特定レベルのログを表示 |
エラーログのみなど、レベル別にログをフィルタ |
supabase debug |
デバッグ情報を表示 |
詳細なデバッグ情報を出力 |
設定・管理
コマンド |
説明 |
用途 |
supabase config |
設定を表示 |
現在の設定を確認 |
supabase config set |
設定を変更 |
特定の設定値を更新 |
supabase config unset |
設定を削除 |
設定値を削除 |
supabase update |
CLI を更新 |
Supabase CLI を最新バージョンに更新 |
supabase version |
バージョンを表示 |
現在の CLI バージョンを確認 |
Discussion