Supabase

Open-source backend platform CLI. Manage databases, auth, storage, edge functions, and local development.

62 commands

Browse by Topic

Getting Started

Quick setup and installation

3commands

Database

Database operations

11commands

Functions

Edge Functions

6commands

Migrations

Database migrations

5commands

Auth

Authentication & secrets

8commands

Storage

File storage buckets

8commands

Inspect

Database diagnostics

8commands

Testing

pgTAP & test helpers

6commands

Branches

Database branching

7commands

Install Supabase CLI (macOS)

$ brew install supabase/tap/supabase

Install the Supabase CLI using Homebrew on macOS

Check Supabase CLI version

$ supabase --version

Verify Supabase CLI is installed and display version

Initialize Supabase project

$ supabase init

Initialize a new Supabase project in the current directory

Show schema diff

$ supabase db diff

Show differences between local and remote schema

Dump database

$ supabase db dump -f dump.sql

Dump database schema to SQL file

Lint database

$ supabase db lint

Lint database for potential issues

Pull remote schema

$ supabase db pull

Pull schema changes from remote database

Push schema changes

$ supabase db push

Push local schema changes to remote database

Reset database

$ supabase db reset

Reset local database to initial state

Initialize Supabase

$ supabase init

Initialize Supabase in current directory

Link to project

$ supabase link --project-ref <ref>

Link local project to remote Supabase project

Start local Supabase

$ supabase start

Start local Supabase development stack

Check status

$ supabase status

Show status of local Supabase services

Stop local Supabase

$ supabase stop

Stop local Supabase development stack

Delete function

$ supabase functions delete <name>

Delete an Edge Function

Deploy all functions

$ supabase functions deploy

Deploy all Edge Functions to remote

Deploy specific function

$ supabase functions deploy <name>

Deploy a specific Edge Function

List functions

$ supabase functions list

List all deployed Edge Functions

Create new function

$ supabase functions new <name>

Create a new Edge Function

Serve functions locally

$ supabase functions serve

Serve Edge Functions locally for development

List migrations

$ supabase migration list

List all migrations and their status

Create migration

$ supabase migration new <name>

Create a new migration file

Repair migrations

$ supabase migration repair --status applied <version>

Repair migration history

Squash migrations

$ supabase migration squash

Squash migrations into a single file

Apply migrations

$ supabase migration up

Apply pending migrations to local database

Generate TypeScript types

$ supabase gen types typescript --local > types/supabase.ts

Generate TypeScript types from database schema

Generate types from remote

$ supabase gen types typescript --project-id <id> > types/supabase.ts

Generate TypeScript types from remote database

Login to Supabase

$ supabase login

List organizations

$ supabase orgs list

List all organizations

List projects

$ supabase projects list

List all Supabase projects

List secrets

$ supabase secrets list

List all secrets for Edge Functions

Set secret

$ supabase secrets set <name>=<value>

Set a secret for Edge Functions

Unset secret

$ supabase secrets unset <name>

Remove a secret from Edge Functions

Delete file from storage

$ supabase storage rm supabase://bucket/file.png --linked

Delete file from remote storage

Delete folder recursively

$ supabase storage rm supabase://bucket/folder/ --recursive --local

Delete folder and contents recursively

Download file from storage

$ supabase storage cp supabase://bucket/file.png ./downloads/ --linked

Download file from remote storage

List local storage objects

$ supabase storage ls --local

List all storage objects locally

List remote storage objects

$ supabase storage ls --linked

List remote storage objects

Move or rename object

$ supabase storage mv supabase://bucket/old.png supabase://bucket/new.png --local

Move or rename storage object

Upload file to storage

$ supabase storage cp ./file.png supabase://bucket/file.png --local

Upload file to storage bucket

Upload directory recursively

$ supabase storage cp ./assets/ supabase://images/ --recursive --local

Upload directory recursively to storage

Show table and index bloat

$ supabase inspect db bloat --linked

Show table and index bloat estimation

Show blocking queries

$ supabase inspect db blocking --local

Show queries holding locks and blocking others

List queries by frequency

$ supabase inspect db calls --linked

List queries ordered by call frequency

Show index stats

$ supabase inspect db index-stats --linked

Show index performance and usage stats

Show exclusive locks

$ supabase inspect db locks --local

Show queries with exclusive locks

List long-running queries

$ supabase inspect db long-running-queries --linked

List queries running longer than 5 minutes

Show query outliers

$ supabase inspect db outliers --local

Show statements by total execution time

Show vacuum stats

$ supabase inspect db vacuum-stats --local

Show vacuum activity and dead row counts

Run database tests

$ supabase test db

Run all pgTAP database tests

Debug function with breakpoint

$ supabase functions serve <name> --inspect-mode brk

Serve function with debugger breakpoint

Create new test file

$ supabase test new <name>

Create new pgTAP test file

Serve without JWT verification

$ supabase functions serve --no-verify-jwt

Serve functions without JWT verification

Reset and seed database

$ supabase db reset --seed

Reset database and run seed file

Serve with test env

$ supabase functions serve --env-file .env.test

Serve functions with test environment

Create preview branch

$ supabase branches create <name>

Create new preview branch

Create persistent branch

$ supabase branches create <name> --persistent

Create persistent staging branch

Delete preview branch

$ supabase branches delete <name>

Delete a preview branch

Disable branching

$ supabase branches disable

Disable branching for project

Get branch details

$ supabase branches get <name>

Get details about a preview branch

Export branch credentials

$ supabase branches get <name> -o env

Export branch credentials as env vars

List preview branches

$ supabase branches list

List all preview branches

Discussion

Loading comments...

Supabase

Open-source backend platform CLI. Manage databases, auth, storage, edge functions, and local development.

62 commands

Browse by Topic

Getting Started

Quick setup and installation

3commands

Database

Database operations

11commands

Functions

Edge Functions

6commands

Migrations

Database migrations

5commands

Auth

Authentication & secrets

8commands

Storage

File storage buckets

8commands

Inspect

Database diagnostics

8commands

Testing

pgTAP & test helpers

6commands

Branches

Database branching

7commands

Install Supabase CLI (macOS)

$ brew install supabase/tap/supabase

Install the Supabase CLI using Homebrew on macOS

Check Supabase CLI version

$ supabase --version

Verify Supabase CLI is installed and display version

Initialize Supabase project

$ supabase init

Initialize a new Supabase project in the current directory

Show schema diff

$ supabase db diff

Show differences between local and remote schema

Dump database

$ supabase db dump -f dump.sql

Dump database schema to SQL file

Lint database

$ supabase db lint

Lint database for potential issues

Pull remote schema

$ supabase db pull

Pull schema changes from remote database

Push schema changes

$ supabase db push

Push local schema changes to remote database

Reset database

$ supabase db reset

Reset local database to initial state

Initialize Supabase

$ supabase init

Initialize Supabase in current directory

Link to project

$ supabase link --project-ref <ref>

Link local project to remote Supabase project

Start local Supabase

$ supabase start

Start local Supabase development stack

Check status

$ supabase status

Show status of local Supabase services

Stop local Supabase

$ supabase stop

Stop local Supabase development stack

Delete function

$ supabase functions delete <name>

Delete an Edge Function

Deploy all functions

$ supabase functions deploy

Deploy all Edge Functions to remote

Deploy specific function

$ supabase functions deploy <name>

Deploy a specific Edge Function

List functions

$ supabase functions list

List all deployed Edge Functions

Create new function

$ supabase functions new <name>

Create a new Edge Function

Serve functions locally

$ supabase functions serve

Serve Edge Functions locally for development

List migrations

$ supabase migration list

List all migrations and their status

Create migration

$ supabase migration new <name>

Create a new migration file

Repair migrations

$ supabase migration repair --status applied <version>

Repair migration history

Squash migrations

$ supabase migration squash

Squash migrations into a single file

Apply migrations

$ supabase migration up

Apply pending migrations to local database

Generate TypeScript types

$ supabase gen types typescript --local > types/supabase.ts

Generate TypeScript types from database schema

Generate types from remote

$ supabase gen types typescript --project-id <id> > types/supabase.ts

Generate TypeScript types from remote database

Login to Supabase

$ supabase login

List organizations

$ supabase orgs list

List all organizations

List projects

$ supabase projects list

List all Supabase projects

List secrets

$ supabase secrets list

List all secrets for Edge Functions

Set secret

$ supabase secrets set <name>=<value>

Set a secret for Edge Functions

Unset secret

$ supabase secrets unset <name>

Remove a secret from Edge Functions

Delete file from storage

$ supabase storage rm supabase://bucket/file.png --linked

Delete file from remote storage

Delete folder recursively

$ supabase storage rm supabase://bucket/folder/ --recursive --local

Delete folder and contents recursively

Download file from storage

$ supabase storage cp supabase://bucket/file.png ./downloads/ --linked

Download file from remote storage

List local storage objects

$ supabase storage ls --local

List all storage objects locally

List remote storage objects

$ supabase storage ls --linked

List remote storage objects

Move or rename object

$ supabase storage mv supabase://bucket/old.png supabase://bucket/new.png --local

Move or rename storage object

Upload file to storage

$ supabase storage cp ./file.png supabase://bucket/file.png --local

Upload file to storage bucket

Upload directory recursively

$ supabase storage cp ./assets/ supabase://images/ --recursive --local

Upload directory recursively to storage

Show table and index bloat

$ supabase inspect db bloat --linked

Show table and index bloat estimation

Show blocking queries

$ supabase inspect db blocking --local

Show queries holding locks and blocking others

List queries by frequency

$ supabase inspect db calls --linked

List queries ordered by call frequency

Show index stats

$ supabase inspect db index-stats --linked

Show index performance and usage stats

Show exclusive locks

$ supabase inspect db locks --local

Show queries with exclusive locks

List long-running queries

$ supabase inspect db long-running-queries --linked

List queries running longer than 5 minutes

Show query outliers

$ supabase inspect db outliers --local

Show statements by total execution time

Show vacuum stats

$ supabase inspect db vacuum-stats --local

Show vacuum activity and dead row counts

Run database tests

$ supabase test db

Run all pgTAP database tests

Debug function with breakpoint

$ supabase functions serve <name> --inspect-mode brk

Serve function with debugger breakpoint

Create new test file

$ supabase test new <name>

Create new pgTAP test file

Serve without JWT verification

$ supabase functions serve --no-verify-jwt

Serve functions without JWT verification

Reset and seed database

$ supabase db reset --seed

Reset database and run seed file

Serve with test env

$ supabase functions serve --env-file .env.test

Serve functions with test environment

Create preview branch

$ supabase branches create <name>

Create new preview branch

Create persistent branch

$ supabase branches create <name> --persistent

Create persistent staging branch

Delete preview branch

$ supabase branches delete <name>

Delete a preview branch

Disable branching

$ supabase branches disable

Disable branching for project

Get branch details

$ supabase branches get <name>

Get details about a preview branch

Export branch credentials

$ supabase branches get <name> -o env

Export branch credentials as env vars

List preview branches

$ supabase branches list

List all preview branches

Discussion

Loading comments...