Supabase CLI The Supabase CLI provides tools to develop your project locally and deploy to the Supabase Platform.
The CLI is still under development, but it contains all the functionality for working with your Supabase projects and the Supabase Platform.
Global flags Supabase CLI supports global flags for every command.
Flags output debug logs to stderr
--experimental Optional
no type enable experimental features
-h, --help Optional
no type help for supabase
--workdir <string> Optional
no type path to a Supabase project directory
$ supabase test
$ supabase test db
$ supabase stop
$ supabase status
$ supabase start Flags -x, --exclude <strings> REQUIRED
no type Names of containers to not start. [gotrue, realtime, storage-api, imgproxy, kong, inbucket, postgrest, pgadmin-schema-diff, migra, postgres-meta, studio, deno-relay]
$ supabase login
$ supabase link
$ supabase init
$ supabase gen
$ supabase gen types
$ supabase gen types typescript Flags --db-url <string> REQUIRED
no type Generate types from a database url.
Generate types from the linked project.
Generate types from the local dev database.
--project-id <string> REQUIRED
no type Generate types from a project ID.
--schema <stringArray> REQUIRED
no type Schemas to generate types for.
supabase gen types typescript [flags]
$ supabase db
$ supabase db reset
$ supabase db remote
$ supabase db remote commit supabase db remote commit
$ supabase db push Flags Print the migrations that would be applied, but don't actually apply them.
-p, --password <string> REQUIRED
no type Password to your remote Postgres database.
$ supabase db lint
$ supabase db diff Flags -f, --file <string> REQUIRED
no type Saves schema diff to a file.
Diffs local schema against linked project.
-s, --schema <strings> REQUIRED
no type List of schema to include.
--use-migra REQUIRED
no type Use migra to generate schema diff.
$ supabase migration
$ supabase migration new supabase migration new <migration name>
$ supabase migration list supabase migration list [flags]
$ supabase migration repair supabase migration repair <version> [flags]
$ supabase secrets
$ supabase secrets unset supabase secrets unset <NAME> ...
$ supabase secrets set supabase secrets set [flags] <NAME=VALUE> ...
$ supabase secrets list
$ supabase projects
$ supabase projects list
$ supabase projects create Flags --db-password <string> REQUIRED
no type Database password of the project.
-i, --interactive REQUIRED
no type Enables interactive mode.
--org-id <string> REQUIRED
no type Organization ID to create the project in.
--plan <[ free | pro ]> REQUIRED
no type Select a plan that suits your needs.
Open accepted values free REQUIRED
[ free | pro ] nodescription
pro REQUIRED
[ free | pro ] nodescription
--region <string> REQUIRED
no type Select a region close to you for the best performance.
Open accepted values ap-northeast-1 REQUIRED
string nodescription
ap-northeast-2 REQUIRED
string nodescription
ap-southeast-1 REQUIRED
string nodescription
ap-southeast-2 REQUIRED
string nodescription
ca-central-1 REQUIRED
string nodescription
eu-central-1 REQUIRED
string nodescription
supabase projects create <project name> [flags]
$ supabase orgs
$ supabase orgs list
$ supabase functions
$ supabase functions serve supabase functions serve <Function name> [flags]
$ supabase functions new supabase functions new <Function name>
$ supabase functions deploy Flags --import-map <string> REQUIRED
no type Path to import map file.
--legacy-bundle REQUIRED
no type Use legacy bundling mechanism.
--no-verify-jwt REQUIRED
no type Disable JWT verification for the Function.
--project-ref <string> REQUIRED
no type Project ref of the Supabase project.
supabase functions deploy <Function name> [flags]
$ supabase functions delete supabase functions delete <Function name> [flags]
$ supabase domains
$ supabase domains reverify supabase domains reverify
$ supabase domains get
$ supabase domains delete
$ supabase domains create Flags --custom-hostname <string> REQUIRED
no type The custom hostname to use for your Supabase project.
--include-raw-output REQUIRED
no type Include raw output (useful for debugging).
--project-ref <string> REQUIRED
no type Project ref of the Supabase project.
supabase domains create [flags]
$ supabase domains activate supabase domains activate
$ supabase vanity-subdomains
$ supabase vanity-subdomains check-availability supabase vanity-subdomains check-availability [flags]
$ supabase vanity-subdomains activate supabase vanity-subdomains activate [flags]
$ supabase vanity-subdomains delete supabase vanity-subdomains delete
$ supabase vanity-subdomains get supabase vanity-subdomains get
$ supabase network-restrictions
$ supabase network-restrictions get supabase network-restrictions get
$ supabase network-restrictions update Flags --bypass-cidr-checks REQUIRED
no type Bypass some of the CIDR validation checks.
--db-allow-cidr <strings> REQUIRED
no type CIDR to allow DB connections from.
--project-ref <string> REQUIRED
no type Project ref of the Supabase project.
supabase network-restrictions update [flags]
$ supabase completion
$ supabase completion zsh supabase completion zsh [flags]
$ supabase completion powershell supabase completion powershell [flags]
$ supabase completion fish supabase completion fish [flags]
$ supabase completion bash 
