Getting Started

Client Library Reference

PythonCommunity

Tools

getting-started

Getting Started

Local Development

Framework Quickstarts

Web app tutorials

Mobile tutorials

database

Database Connections

Tables and Data

Database Functions

Database Webhooks

Full Text Search

Database Testing

Serverless APIs

Generating Types

Postgres resources

Managing Indexes

Drop All Tables in Schema

Select First Row per Group

Print PostgreSQL Version

Configuration

realtime

Features

Postgres Changes

Guides

Subscribing to Database Changes

Bring Your Own Database

Using Realtime with Next.js

Deep dive

storage

Image Transformations

reference-cli

Local Development

Managing Environments

Reference

platform

Add-ons

Compute Add-ons

Database Backups

Platform Management

HTTP Status Codes

Migrating and Upgrading

Network Restrictions

Performance Tuning

SSL Enforcement

Billing

Single sign-on

Enable SSO for your organization

SSO with Azure AD

SSO with Google Workspace

Go-live Checklist

Production Readiness

Troubleshooting

HTTP and Project Issues

resources

Migrate to Supabase

Firebase Storage

resources

Self-Hosting with Docker

Auth Server

Storage Server

Realtime Server

integrations

Auth

Caching / Offline-first

Developer Tools

Low-code

Messaging

reference

Client libraries

supabase-csharp

Other tools

Back to Main Menu

reference-javascript

JavaScript

Typescript Support

Database

Call a Postgres function

Using Modifiers

Auth

Create a new user

Sign in a user through OTP

Sign in a user through OAuth

Sign out a user

Verify and log in through OTP

Retrieve a session

Retrieve a new session

Retrieve a user

Set the session data

Listen to auth events

Send a password reset request

Enroll a factor

Create a challenge

Verify a challenge

Create and verify a challenge

Unenroll a factor

Get Authenticator Assurance Level

Functions

Invoke a function

Realtime

Subscribe to channel

Unsubscribe from a channel

Unsubscribe from all channels

Retrieve all channels

Storage

Create a bucket

Retrieve a bucket

List all buckets

Update a bucket

Delete a bucket

Download a file

List all files in a bucket

Replace an existing file

Move an existing file

Copy an existing file

Delete files in a bucket

Create a signed URL

Create signed URLs

Retrieve public URL

Misc

Back to Main Menu

reference-cli

Supabase CLI

General

Initialize a local project

Log in to a Supabase account

Link to a Supabase project

Start a container

Stop all containers

Retrieve container status

Testing

Run tests (pgTAP)

Generate Types

Run code generation tools

Generate types (Postgres schema)

Generate types (TypeScript)

Database

Manage local databases

Dump schema from remote database

Push migration to remote database

Reset local database

Diff local database

Lint local database

Manage remote databases

Commit remote database changes

Migrations

Manage database migrations

Create a migration

List all migrations

Repair migration history table

Projects

Manage projects

Create a project

List all projects

Organizations

Manage organizations

List all organizations

Edge Functions

Manage edge functions

Create a function

Download a function

Serve functions locally

Deploy a function

Delete a function

Secrets

List all secrets

Custom Domains

Manage custom domains

Activate custom hostname

Create a custom hostname

Retrieve custom hostname config

Re-verify custom hostname config

Delete custom hostname config

Vanity Subdomains

Manage vanity subdomains

Activate a vanity subdomain

Retrieve vanity subdomain

Check subdomain availability

Delete vanity subdomain

Network Bans

Manage network bans

Retrieve network bans

Remove a network ban

Network Restrictions

Manage network restrictions

Retrieve network restrictions

Update network restrictions

SSL Enforcement

Manage SSL enforcement configuration

Get the current SSL enforcement configuration

Update SSL enforcement configuration

Autocompletion Scripts

Generate autocompletion scripts

Generate zsh script

Generate powershell script

Generate fish script

Generate bash script

Back to Main Menu

reference-auth

Self-Hosting Auth

Usage

Generates an email action link

Returns the created user

Redirects the user to the 3rd party oauth provider to start the oauth1 0 or oauth2 0 authentication process

Receives the redirect from an external provider during the oauth authentication process starts the process of creating an access and refresh token

The healthcheck endpoint for gotrue returns the current gotrue version

Sends an invite link to the user

Logs out the user

Passwordless sign in method for email or phone

Sends a password recovery email link to the users email

Returns the configuration settings for the gotrue server

Password based signup with either email or phone

Signs in a user with a password

Refreshes a users refresh token

Get information for the logged in user

Returns the updated user

Verifies a sign up

Back to Main Menu

reference-auth

Self-Hosting Realtime

Home

Supabase CLI

The Supabase CLI provides tools to develop your project locally and deploy to the Supabase Platform. You can also use the CLI to manage your Supabase projects, handle database migrations and CI/CD workflows, and generate types directly from your database schema.

Installation#

Install the CLI as dev dependency via npm:

npm install supabase --save-dev

Updates#

When a new version is released, you can update the CLI using the same methods.

npm update supabase --save-dev

See also#

Edit this page on GitHub

Need some help?

Not to worry, our specialist engineers are here to help. Submit a support ticket through the Dashboard.

Supabase 2022—Contributing Changelog Author Styleguide Open Source SupaSquad