Supabase CLIでよく使うコマンド一覧|用途別

プロジェクト管理

supabase init

  • 新しいSupabaseプロジェクトを初期化
  • ローカル開発環境のセットアップ時に使用

supabase login

  • Supabaseアカウントにログイン
  • リモートプロジェクトとの連携に必要

supabase projects list

  • 利用可能なプロジェクト一覧を表示
  • どのプロジェクトにアクセス可能か確認

supabase link --project-ref <project-id>

  • ローカルプロジェクトをリモートプロジェクトと連携
  • デプロイやマイグレーション同期に必要

ローカル開発環境

supabase start

  • ローカルのSupabaseスタック(PostgreSQL、API、Dashboard等)を起動
  • 開発時の基本コマンド

supabase stop

  • ローカルスタックを停止
  • 開発終了時やリソース節約に使用

supabase status

  • ローカルサービスの稼働状況を確認
  • 各サービスのURL、ステータスを表示

supabase logs

  • ローカルサービスのログを表示
  • デバッグ時に使用

データベース管理

supabase db reset

  • ローカルデータベースをリセット
  • 初期状態に戻したい時やマイグレーション問題の解決に使用

supabase db push

  • ローカルのスキーマ変更をリモートデータベースに適用
  • 開発環境から本番環境への反映

supabase db pull

  • リモートのスキーマをローカルに取得
  • 本番環境の構造をローカルに同期

supabase db diff

  • ローカルとリモートのスキーマ差分を表示
  • デプロイ前の変更内容確認

マイグレーション

supabase migration new <migration-name>

  • 新しいマイグレーションファイルを作成
  • データベーススキーマの変更管理

supabase migration up

  • 未適用のマイグレーションを実行
  • スキーマ変更をデータベースに反映

supabase migration list

  • マイグレーション履歴を表示
  • 適用済み/未適用の状況確認

関数管理

supabase functions new <function-name>

  • 新しいEdge Functionを作成
  • サーバーレス関数の開発開始

supabase functions serve

  • ローカルで関数をテスト実行
  • 開発中の動作確認

supabase functions deploy <function-name>

  • Edge Functionをデプロイ
  • 本番環境への関数公開

型生成

supabase gen types typescript --local

  • ローカルDBスキーマからTypeScript型定義を生成
  • 型安全な開発のため

supabase gen types typescript --project-id <project-id>

  • リモートDBから型定義を生成
  • 本番データベースの型を取得

その他のユーティリティ

supabase --help

  • 利用可能なコマンドとオプションを表示
  • 困った時の基本コマンド

supabase <command> --help

  • 特定のコマンドの詳細ヘルプを表示
  • 各コマンドの使用方法確認

これらのコマンドを組み合わせることで、Supabaseプロジェクトの開発からデプロイまでの一連のワークフローを効率的に管理できます。

WSLターミナルでよく使うコマンド一覧はこちらから。

コメント

タイトルとURLをコピーしました