supabase
TLDR
Log in to Supabase using an access token
Initialize a new Supabase project in the current directory
Start the local Supabase development stack
Stop the local Supabase development stack
Show the status of the local Supabase development stack
Link the current directory to a remote Supabase project
List all Supabase projects
SYNOPSIS
supabase [<global-options>] <command> [<args>]
PARAMETERS
--debug
Print debug information
--experimental
Enable experimental features
--version, -v
Show supabase version
--help, -h
Show help
--dashboard
Open Supabase Dashboard for linked project
DESCRIPTION
The supabase command is the official CLI tool for Supabase, an open-source Firebase alternative built on Postgres. It simplifies local development by allowing users to initialize projects, start self-hosted Supabase stacks (including database, auth, realtime, storage, and APIs), manage migrations, deploy to remote projects, handle secrets, and generate TypeScript types.
Key workflows include running supabase start to launch a Docker-based local environment in seconds, linking local setups to cloud projects with supabase link, and deploying changes via supabase db push or supabase functions deploy. It's essential for full-stack developers building scalable apps with Postgres at the core.
Designed for speed and ease, the CLI abstracts complex Docker Compose orchestration, supports CI/CD pipelines, and integrates with Supabase Dashboard. Global flags like --debug aid troubleshooting, while subcommands cover database ops, edge functions, and more. Widely used in modern web dev stacks.
CAVEATS
Requires Docker installed and running for local services like supabase start. Local mode is for development only, not production. Some features need a linked Supabase project.
INSTALLATION
npm install -g supabase or brew install supabase/tap/supabase. Supports npm, Homebrew, Scoop.
QUICKSTART
supabase init
supabase start to launch local stack.
supabase login for cloud access.
MAIN SUBCOMMANDS
init, start, stop, link, db, functions, deploy, secrets, gen(types), migration.
HISTORY
Released in 2021 alongside Supabase platform v1.0. Evolved from early alpha tools; now stable v1.100+, rewritten in Go for performance. Key updates include edge functions support (2022) and streamlined migrations.
SEE ALSO
docker-compose(1), psql(1)
