Supabase CLIコマンド一覧

Supabase CLI』は、Supabaseのプロジェクトをローカルで実行させることが出来る、非常に有用なツールです。
今回はその『Supabase CLI』のコマンドについてご紹介します。

なおSupabaseの優秀さ・機能一覧等を過去の記事で紹介していますので、こちらもご確認ください!

あわせて読みたい
Supabaseの機能一覧・解説 オープンソースのFirebase代替mBaaS 前回『Firebaseの機能一覧』についてご紹介しましたが、『機能が多すぎる』と感じた方もいらっしゃるでしょう。もっとシンプルに、安く、使いやすいmBaaSはないのでしょ...
目次

init

Supabaseローカル開発環境の初期化用コマンド
Supabaseの各種設定を保存するconfig.tomlや、その他必要なディレクトリが生成される。

コマンド

supabase init

オプション

–use-orioledb
Supabaseで利用されている『OrioleDB』を、初期設定で利用することができるオプション。
なお『OrioleDB』は、Postgresの開発者が新たに開発したDB

–with-vscode-workspace
VS Codeのワークスペースを、Supabaseの初期化と同時に作成する。
VS Codeで開発する場合には便利。

login

個人アクセス用のトークンを利用して、ローカル環境とSupabaseを接続する。
アクセストークンは下記ページで生成できる。
https://app.supabase.com/account/tokens

コマンド

supabase login

オプション

–name [トークン名]

supabase login –name “トークン”

トークンの名前を設定することができる。デフォルトでは、ランダムに生成された名前となる

–no-browser

supabase login –no-browser

デフォルトでは、ログインのために自動でブラウザを開きアクセスを行うが、このオプションを利用するとブラウザを自動で開かない。

–token [トークン名] 
自動ログイン時の対話式プロンプトを省略し、既に保存済みのトークンを利用してログインする。

link

ローカルのSupabaseプロジェクトを、ホスト済みのSupabaseプロジェクトとリンクさせるコマンド。
特にDB関係のコマンド(db dump、db push、db remote commitなど)を利用する際に、プロジェクトのリンクが必要になります。

コマンド

supabase link --project-ref project

オプション

-p, –password [パスワード]

supabase link  --project-ref project –password *******

データベースへリモート接続するためのパスワードを、入力するオプション。
(直接入力したくない場合は、SUPABASE_DB_PASSWORDという環境変数にパスワードを入れることで対応可能)

–project-ref [プロジェクトID]
リンクしたいプロジェクトを指定するオプション。基本必須。

start

ローカルのSupabase開発環境を起動する。
実行前にsupabase initをして、プロジェクトの初期化を行なう必要がある。
オプションを付けないとすべての必要なサービスを起動してしまうため、そこそこメモリが必要になる(少なくともRAM7GB)

コマンド

supabase start

オプション

-x, –exclude [サービス名]

supabase start -x gotrue,imgproxy

指定したサービス名のサービスを除外して起動する。

サービス名一覧:

  • gotrue
  • realtime
  • storage-api
  • imgproxy
  • kong
  • inbucket
  • postgrest
  • pgadmin-schema-diff
  • migra
  • postgres-meta
  • studio
  • edge-runtime
  • logflare
  • vector
  • pgbouncer

–ignore-health-check

supabase start --ignore-health-check

何らかの問題があるサービスがあっても無視し、正常終了させる。

stop

supabase startで起動したSupabaseの、ローカル開発環境を停止する。

コマンド

supabase stop

オプション

–no-backup

supabase stop –no-backup

本来、全てのリソースは維持されるが、再起動時に開発データをリセットしたい場合はこのコマンドを利用する。

status

Supabaseのローカル開発環境の状態を表示する。
supabase startやsupabase db startを利用して、プロジェクトが起動している状態でないと利用できないコマンド。

コマンド

supabase status

オプション

-o, –output [ env | pretty | json | toml | yaml ]

supabase status -o env

各種ステータス情報を、表示するオプション
特にsupabaseのクライアントライブラリである『supabase-js』の初期化時に-o envを利用する。
https://supabase.com/docs/reference/javascript/initializing

–override-name [変数名]

supabase status –override-name variable

変数名の上書きをするオプション

test

ローカルのSupabaseでテストを行うためのコマンド

コマンド

supabase test db

『pgTAP』と、それを一括で実行する『pg_prove』というテスト用ライブラリを利用し、単体テストを行うコマンド。
事前にsupabase startを行い、プロジェクトが起動している必要がある。
またテスト用のsqlファイル、pgファイルを、supabase/testディレクトリに入れておく必要がある。

supabase test new [ファイル名]

新規のテストファイルを作成するコマンド

オプション(supabase test new)

–template [ pgtap ]

supabase test new --template pgtap

テストファイル作成に利用する、テストのテンプレートフレームワークを設定するオプション
(現在はpgtapしかないので不要なオプション)

gen

コード生成用コマンド。

コマンド

supabase gen keys

プレビューブランチ用のキー生成コマンド

supabase gen types typescript

Typescriptのためのデータベース型生成用コマンド。
下記オプション(–local、–linked、–project-id、–db-url)でデータベースと結びつけて実行する必要がある。

オプション(supabase gen keys)

-o, –output [ env | json | toml | yaml ]
指定した形式でキー情報を出力するためのオプション

–override-name [上書きする名前]
特定の変数名を上書きするオプション

–project-ref [プロジェクトID]
コマンドを利用するプロジェクトを指定するオプション

–experimental
実験的なコマンドにつける必須オプション

オプション(supabase gen types typescript)

–db-url [データベースのURL]
型を生成するデータベースをURLで指定する。

–linked
リンク済のSupabaseプロジェクトにあるデータベースの型を生成する。

–local
ローカル開発環境のデータベースの型を生成する。

–project-id [プロジェクトID]
『IDで指定したSupabaseプロジェクト』内に存在する『データベースの型』を生成する。

–schema [スキーマ]
型を生成するために利用する、データベーススキーマの指定

db

データベースを管理するためのコマンド。

コマンド

supabase db pull

リモートデータベースの、最新のスキーマを取ってくるコマンド。
実行前にsupabase linkを実行し、リモートのデータベースとローカル開発環境を結びつける必要がある。
自前でホストしている場合は、上記の代わりに–db-urlオプションを利用してデータベースと接続する。

supabase db push

ローカルのデータベースの内容で、リモートデータベースを更新するコマンド。pullと同じく実行前に『supabase link』を実行するか、『–db-url』を利用する必要がある。

supabase db reset

ローカルデータベースをリセットする。(ローカル内のデータやスキーマの変更が削除され、supabase/migrationsディレクトリの情報を元にデータベースを再作成する。)
supabase startを実行して、事前にローカル環境が起動している必要がある。

supabase db dump

データベースの内容をdump(データ取得)できる。
実行前にsupabase linkを実行し、リモートのデータベースとローカル開発環境を結びつける必要がある。
自前でホストしている場合は上記の代わりに、–db-urlオプションを利用してデータベースと接続する。

supabase db diff

データベースのスキーマの差分を比較するコマンド。
ローカルデータベースに対して実行する場合、supabase startを実行して、事前にローカル環境が起動している必要がある。
リモートに対して実行する場合は、–linkedか–db-urlオプションを利用してデータベースを指定する必要がある。

supabase db lint

データベースのスキーマの問題を特定する。
ローカルデータベースに対して実行する場合、supabase startを実行して、事前にローカル環境が起動している必要がある。
リモートに対して実行する場合は、–linkedか–db-urlオプションを利用してデータベースを指定する必要がある。

supabase db start

ローカルのデータベースを起動するコマンド

オプション(共通)

–db-url [データベースurl]
データベースをURLベースで指定する。
pull、push、reset、dump、diff、lintで利用

–linked
リンク済みのプロジェクトのデータベースを利用する
pull、push、reset、dump、diff、lintで利用

–local
ローカルのデータベースを利用する
pull、push、reset、dump、diff、lintで利用

-p, –password [パスワード]
リモートのデータベースにアクセスするためのパスワード入力
pull、push、dumpで利用

-s, –schema [スキーマ名]
今回の作業に含むスキーマの指定
pull、dump、diff、lintで利用

–dry-run
実行前に実行内容を表示できるオプション。
空実行。
push、dumpで利用

-f, –file [ファイルパス]
保存先のファイルを指定
dump、diffで利用

オプション(push)

–include-all
リモート側の履歴に存在しない全ての変更をプッシュする

–include-roles
supabase/roles.sqlのデータを元にデータベースのロールを含めてプッシュする

–include-seed
supabase/seed.sqlのデータを元にデータベースのシードデータを含めてプッシュする

オプション(reset)

–version [バージョン]
指定したバージョンまで遡ってリセットする。

オプション(dump)

–data-only
データだけを含んでdumpする
(デフォルトのdumpにはデータが含まれない)

–keep-comments
dumpの出力にコメント行を含める

–role-only
ロールだけを含んでdumpする
(デフォルトのdumpにはロールが含まれない)

–use-copy
データを挿入する代わりにコピーを利用する

オプション(diff)

–use-migra
下記のmigraというライブラリをdiffの生成に利用する
https://github.com/djrobstep/migra

–use-pgadmin
下記のpdadminをdiffの生成に利用する
https://www.pgadmin.org/

オプション(lint)

–level [ warning | error ]
lintの報告レベルを警告かエラーのどちらかに選択する。(デフォルトはwarning)

migration

データベースマイグレーション用スクリプトの管理用コマンド

コマンド

supabase migration new

新規のマイグレーションファイルをローカルに作成する。

supabase migration list

ローカルとリモートのデータベースマイグレーション履歴を一覧で表示する。
実行前にsupabase linkを実行し、リモートのデータベースとローカル開発環境を結びつける必要がある。
自前でホストしている場合は、上記の代わりに–db-urlオプションを利用してデータベースと接続する。

supabase migration repair

リモートの『マイグレーション履歴テーブル』を修復する。
実行前にsupabase linkを実行し、リモートのデータベースとローカル開発環境を結びつける必要がある。
リモートとローカルのマイグレーション履歴が同期しなくなってしまった場合に、特定のマイグレーションを挿入、削除することで修復する用途でよく用いられる。

supabase migration squash

マイグレーションファイルを1ファイルに纏めるコマンド。
増えすぎたマイグレーションファイルをまとめることで、パフォーマンスを改善できる。

supabase migration up

保留中のマイグレーションをローカルデータベースに適用する。

オプション(共通)

–db-url [データベースurl]
データベースをURLベースで指定する。
list、repair、squash、upで利用

–linked
リンク済みのプロジェクトのデータベースを利用する
list、repair、squash、upで利用

–local
ローカルのデータベースを利用する
list、repair、squash、upで利用

-p, –password [パスワード]
リモートのデータベースにアクセスするためのパスワード入力
list、repair、squashで利用

オプション(repair)

–status [ applied | reverted ]
repairの必須オプション
applied(マイグレーションの挿入)、reverted(マイグレーションの削除)のどちらかをマークするために利用する。

オプション(squash)

–version [バージョン]
特定のバージョンのマイグレーションファイルまでsquashの対象とする。

オプション(up)

–include-all
リモートの履歴にない全てのマイグレーションをupの対象とする。

inspect

データベースを検査するためのコマンド。
ボトルネックになっているクエリやその他の要素を検索して改善するために利用できる

コマンド

supabase inspect db calls

dbの呼び出し処理を呼び出し回数順に並べるコマンド

supabase inspect db long-running-queries

5分以上実行されている実行時間の長いクエリを長い順に表示するコマンド。

supabase inspect db outliers

pg_stat_statementsというライブラリベースで、実行時間順にクエリを表示するコマンド。

supabase inspect db blocking

他の処理をブロックしているクエリとブロックされている競合クエリを表示するコマンド。

supabase inspect db locks

リレーションに対して排他ロックを行うクエリを表示するコマンド

supabase inspect db total-index-size

データベース上の全てのインデックスのサイズを計測・表示するコマンド

supabase inspect db index-sizes

データベースの各インデックスのサイズを個別に表示するコマンド

supabase inspect db index-usage

データベースに対するスキャン全体の何%がインデックスに対するスキャンであるかを計測するコマンド。%が低いとインデックスが少なく、データベース利用の効率が悪い可能性がある。

supabase inspect db unused-indexes

スキャン回数が50未満かつサイズが5ページ以上のインデックスをその回数 / サイズ順に表示するコマンド。
利用率の低いインデックスを見つけるのに利用。

supabase inspect db total-table-sizes

データベース内の各テーブルの合計サイズを表示するコマンド。

supabase inspect db table-sizes

データベース内の各テーブルのサイズを個別に表示するコマンド。

supabase inspect db table-index-sizes

データベース内の各テーブルのインデックスの合計サイズを表示するコマンド。

supabase inspect db cache-hit

いわゆるキャッシュヒット率の計測用コマンド。
https://www.cloudflare.com/ja-jp/learning/cdn/what-is-a-cache-hit-ratio/
キャッシュをどれくらい利用できているか?また、クエリがメモリではなくディスクにヒットする頻度はどのくらいか、を表示する。

supabase inspect db table-record-counts

各テーブルごとの行数(推定値)を、その行数順に表示するコマンド。

supabase inspect db seq-scans

全テーブルに対して記録されたシークエンシャルスキャンの回数を、多い順に表示するコマンド。
シークエンシャルスキャンが非常に多いテーブルは、インデックスが不足している可能性がある。

supabase inspect db replication-slots

データベース上で設定される『論理レプリケーションスロット』の情報を表示するコマンド。
※倫理レプリケーションスロットは、PostgreSQLのデータベースレプリケーションでWAL(Write-Ahead Logging)を効率的に管理する機能。これにより、プライマリサーバーがスタンバイサーバーへのデータ同期を最適化することができる。

supabase inspect db role-connections

データベースの各ロールの接続数を表示し、どのロールがアクティブな接続を消費しているかを確認できる。

supabase inspect db bloat

テーブルの肥大化の推定値を表示する。

supabase inspect db vacuum-stats

各テーブルのバキュームに関する統計を表示する。
※バキューム=メモリ上残ってしまっている、削除済みのデータを掃除する処理

オプション(全コマンドで共通)

–db-url [データベースurl]
データベースをURLベースで指定する。

–linked
リンク済みプロジェクトのデータベースを利用する

–local
ローカルのデータベースを利用する

projects

Supabaseプロジェクトの管理用コマンド

コマンド

supabase projects create

Supabaseプロジェクトの作成コマンド

supabase projects list

Supabaseプロジェクトを一覧表示するコマンド

supabase projects api-keys

Supabaseプロジェクトの全てのAPIキーを表示するコマンド

supabase projects delete

Supabaseプロジェクトの削除コマンド

オプション(create)

–db-password [パスワード]
プロジェクトのデータベースパスワード入力オプション

-i, –interactive
対話モードを有効にする(対話式にプロジェクト作成ができる)

–org-id [組織ID]
プロジェクト作成のための組織IDを指定するオプション

–plan [ free | pro ]
作成するプロジェクトで、利用するプランを選択するオプション

–region [リージョン]
最も最適な提供地域を設定する

オプション(api-keys)

–project-ref [プロジェクトID]
参照したいプロジェクトの指定

branches

プレビューブランチ管理用コマンド
(ブランチは現在早期アクセス機能でproプランでしか利用できない)

コマンド

supabase branches create

リンクされたプロジェクトのブランチを作成するコマンド

supabase branches list

リンクされたプロジェクトの、全ブランチを一覧表示するコマンド

supabase branches get

指定のプレビューブランチの詳細情報を取得するコマンド

supabase branches update

ID指定したプレビューブランチを更新するコマンド

supabase branches delete

ID指定したプレビューブランチを削除するコマンド

supabase branches disable

リンクされたプロジェクトのブランチ機能を無効化するコマンド

オプション(共通)

–experimental
全コマンドで必須のオプション。
branches自体が実験的なコマンドのため、まだこのオプションが必要になっている

オプション(create)

–region [リージョン]
ブランチのデータベースの提供地域を設定する

オプション(update)

–git-branch [gitのブランチ名]
関連するgitブランチを変更する

–name [プレビューブランチ名]
プレビューブランチ名を変更する

–reset-on-push 
git push時にプレビューブランチをリセットする

orgs

Supabaseの組織を管理するコマンド

コマンド

supabase orgs create

ログインしたユーザで組織を作成するコマンド

supabase orgs list

ログインしたユーザが所属する組織を、一覧表示するコマンド

functions

Supabase Edge Functionsの管理用コマンド

コマンド

supabase functions new

ローカルで新たなfunctionを作成するコマンド

supabase functions list

リンクされたSupabaseプロジェクトの、全functionを一覧表示するコマンド

supabase functions download

リンクされたSupabaseプロジェクトから、functionのソースコードをダウンロードするコマンド

supabase functions serve

全てのfunctionをローカルに提供するコマンド

supabase functions deploy

リンクされたSupabaseプロジェクトに、ローカルのfunctionをデプロイするコマンド

supabase functions delete

リンクされたSupabaseプロジェクトから、functionを削除するコマンド。
ローカルのfunctionだけを削除する訳では無いので注意

オプション(共通)

–project-ref [プロジェクトID]
参照するプロジェクトを指定するオプション
list、download、deploy、deleteで利用

–import-map [ファイルパス]
インポートするマップファイルのパス指定
serve、deployで利用

–no-verify-jwt
functionのjwt認証を無効化する
serve、deployで利用

オプション(serve)

–env-file [ファイルパス]
functionに設定するenvファイルのパス指定

secrets

機密情報を管理するコマンド

コマンド

supabase secrets set

リンクされたSupabaseプロジェクトに、機密情報を設定するコマンド

supabase secrets list

リンクされたSupabaseプロジェクトの、機密情報を一覧で表示するコマンド

supabase secrets unset

リンクされたSupabaseプロジェクトの、機密情報設定を解除するコマンド

オプション(共通)

–project-ref [プロジェクトID]
参照するプロジェクトを指定するオプション

オプション(set)

–env-file [ファイルパス]
envファイルから機密情報を読み取る

storage

Supabase Storageの管理用コマンド

コマンド

supabase storage ls 

Storage内のオブジェクトを一覧表示する

supabase storage cp [src] [dist]

srcパスからdistパスにオブジェクトをコピーする

supabase storage mv [src] [dist]

srcパスからdistパスにオブジェクトを移動する

supabase storage rm

※なおこの他に『ストレージオブジェクトの削除用コマンド』が存在するが、supabaseサイト側の誤植のため情報がない……

オプション(共通)

-r, –recursive
再帰的にディレクトリ構造を処理するためのオプション

–experimental
実験的なコマンドにつける必須オプション

encryption

暗号化キーの管理用コマンド

コマンド

supabase encryption get-root-key

Supabaseプロジェクトのルート暗号化キーを取得するコマンド

supabase encryption update-root-key

Supabaseプロジェクトのルート暗号化キーを更新するコマンド

オプション(共通)

–project-ref [プロジェクトID]
参照するプロジェクトを指定するオプション

sso

SSO認証の管理用コマンド

コマンド

supabase sso add

SSOの認証方法を、新規でプロジェクトに追加するコマンド

supabase sso list

Supabaseプロジェクトの、全ての接続済SSO認証を一覧表示するコマンド

supabase sso show

SSO認証で指定したプロバイダの、接続情報を表示するコマンド

supabase sso info

プロジェクトをプロバイダにSSO接続する際に、必要な情報を提供するコマンド

supabase sso update

既に追加したSSO認証方法の設定を更新するコマンド

supabase sso remove

既に追加したSSO認証方法を、削除するコマンド

オプション(共通)

-o, –output [ env | json | toml | yaml ]
指定した形式でキー情報を出力するためのオプション
全コマンドで利用

–project-ref [プロジェクトID]
参照するプロジェクトを指定するオプション。
全コマンドで利用

–attribute-mapping-file [ファイルパス]
SAML属性とJWTクレーム間のマッピングファイルを指定する
add、updateで利用

–domains [メールアドレスのリスト]
追加したSSO認証方法に関連付けるメールアドレスドメインのリストをカンマ区切りで指定する
add、updateで利用

–metadata-file [ファイルパス]
SSO認証のプロバイダを記述するSAML2.0メタデータXMLを指定する
add、updateで利用

–metadata-url [URL]
上記のmetadata-fileのurl版。
add、updateで利用

–skip-url-validation
SAML2.0メタデータのURLが有効かどうか検証を行わない設定
add、updateで利用

オプション(add)

-t, –type [ saml ]
SSO認証のプロバイダ指定(現在はsamlのみ)
必須のオプション

オプション(show)

–metadata
Saml2.0xml内のメタデータのみ表示する

オプション(update)

–add-domains [メールアドレスのリスト]
SSO認証方法の設定に指定のメールアドレスドメインを追加する
–remove-domains [メールアドレスのリスト]
SSO認証方法の設定から指定のメールアドレスドメインを削除する

domains

Supabaseに結びつくカスタムドメインの管理用コマンド

コマンド

supabase domains activate

Supabaseプロジェクトで、カスタムホスト名設定を有効化するコマンド

supabase domains create

Supabaseプロジェクトに、カスタムホスト名を追加するコマンド

supabase domains get

Supabaseに保存されているカスタムホスト名設定を、取得するコマンド

supabase domains reverify

プロジェクトのカスタムホスト名設定を、再認証するコマンド

supabase domains delete

プロジェクトのカスタムホスト名設定を、削除するコマンド

オプション(共通)

–include-raw-output
デバッグのためにログ情報をraw(編集なし)で出力する
全コマンドで利用

–project-ref [プロジェクトID]
参照するプロジェクトを指定するオプション。
全コマンドで利用

オプション(create)

–custom-hostname [カスタムホスト名]
カスタムホスト名を設定するオプション

vanity-subdomains

サブドメインの管理用コマンド
サブドメインとドメインは排他的(どちらかしか利用できない)

コマンド

supabase vanity-subdomains activate

サブドメインをプロジェクトで有効化するコマンド

supabase vanity-subdomains get

現在のサブドメインを取得するコマンド

supabase vanity-subdomains check-availability

利用したいサブドメインが利用可能であるか検証するコマンド

supabase vanity-subdomains delete

サブドメインをプロジェクトから削除し、通常のドメイン利用に戻すコマンド

オプション(共通)

–experimental
実験的なコマンドにつける必須オプション
全コマンドで利用

–project-ref [プロジェクトID]
参照するプロジェクトを指定するオプション。
全コマンドで利用

–desired-subdomain [ドメイン名]
利用したいサブドメイン名を指定するコマンド
activate、check-availabilityで利用

network-bans

不正なipをブロックする機能のコマンド群

コマンド

supabase network-bans get

現在ブロックされたipを取得するコマンド

supabase network-bans remove

ブロックされたipのデータを削除するコマンド

オプション(共通)

–experimental
実験的なコマンドにつける必須オプション
全コマンドで利用

–project-ref [プロジェクトID]
参照するプロジェクトを指定するオプション。
全コマンドで利用

オプション(remove)

–db-unban-ip <strings>
ブロックされたipのブロック解除を行うオプション

network-restrictions

ネットワーク制限設定の管理用コマンド

コマンド

supabase network-restrictions get

現在のネットワーク制限設定情報の取得

supabase network-restrictions update

ネットワーク制限設定の更新

オプション(共通)

–experimental
実験的なコマンドにつける必須オプション
全コマンドで利用

–project-ref [プロジェクトID]
参照するプロジェクトを指定するオプション。
全コマンドで利用

オプション(update)

–bypass-cidr-checks
cidr検証を一部経由させる
cidrとは

–db-allow-cidr [cidrのリスト]
指定したcidrのdbへの接続許可

ssl-enforcement

SSL接続強制設定の管理用コマンド

コマンド

supabase ssl-enforcement get

現在のSSL接続強制設定の取得

supabase ssl-enforcement update

SSL接続強制設定の更新

オプション(共通)

–experimental
実験的なコマンドにつける必須オプション
全コマンドで利用

–project-ref [プロジェクトID]
参照するプロジェクトを指定するオプション。
全コマンドで利用

オプション(update)

–disable-db-ssl-enforcement
DBに対する全ての外部接続のSSL強制を無効化

–enable-db-ssl-enforcement
DBに対する全ての外部接続のSSL強制を有効化

postgres-config

postgresのデータベース設定の管理用コマンド

コマンド

supabase postgres-config get

現在のpostgresのデータベース設定を取得するコマンド

supabase postgres-config update

postgresのデータベース設定を更新するコマンド

オプション(共通)

–experimental
実験的なコマンドにつける必須オプション
全コマンドで利用

–project-ref [プロジェクトID]
参照するプロジェクトを指定するオプション。
全コマンドで利用

オプション(update)

–config [key=valueのリスト]
key=valueの形で指定の値を上書きする

–replace-existing-overrides
trueの場合、既存の全ての値を指定の値に上書きする。
falseの場合、既存の全ての値に対して統合を行う。

snippets

SQLスニペットの管理用コマンド

コマンド

supabase snippets list

リンクされたプロジェクトの、全てのSQLスニペットを一覧表示する

supabase snippets download [スニペットID]

指定したSQLスニペットの内容をダウンロードする

services

コマンド

supabase services

Supabase内、全サービスのバージョンを表示するコマンド

completion

特定のshell向けの自動補完スクリプトを提供するコマンド群

コマンド

supabase completion zsh

zsh向けの『自動補完スクリプト』を生成するコマンド
下記のコマンドで、zsh自体の自動補完機能を有効にする必要がある

echo "autoload -U compinit; compinit" >> ~/.zshrc

セッションごとに下記を実行することで、自動補完を有効化できる。

source <(supabase completion zsh)

自動補完設定を保存するためにはプラットフォームごとに下記の実行が必要
Linux:

supabase completion zsh > "${fpath[1]}/_supabase"

macOS:

supabase completion zsh > $(brew --prefix)/share/zsh/site-functions/_supabase


supabase completion powershell

powershell向けの自動補完スクリプトを生成するコマンド

下記をpowershellのプロファイルに追加するor毎セッションごとに実行することで自動補完機能を有効化できる

supabase completion powershell | Out-String | Invoke-Expression

supabase completion fish

fishshell向けの自動補完スクリプトを生成するコマンド
現在のセッションで有効化する場合は、下記の実行が必要

supabase completion fish | source

自動補完設定を保存する場合は、下記の実行が必要

supabase completion fish > ~/.config/fish/completions/supabase.fish

supabase completion bash

bash向けの自動補完スクリプトを生成するコマンド
利用には事前にbash-completionパッケージをインストールする必要がある。

セッションごとに下記を実行することで自動補完を有効化できる。

source <(supabase completion bash)

自動補完設定を保存するためにはプラットフォームごとに下記の実行が必要
Linux:

supabase completion bash > /etc/bash_completion.d/supabase

macOS:

supabase completion bash > $(brew --prefix)/etc/bash_completion.d/supabase

オプション(共通)

–no-descriptions
自動補完の説明を無効化するオプション
全コマンドで利用

お問合せ&各種リンク

presented by

  • システム開発、アプリ開発
  • マッチングアプリ開発
  • インフラ構築支援等、なんでもご相談ください。
よかったらシェアしてね!
  • URLをコピーしました!
目次