cli
Supabase CLI. Manage postgres migrations, run Supabase locally, deploy edge functions. Postgres backups. Generating types from your database schema.
What is cli?
Supabase CLI. Manage postgres migrations, run Supabase locally, deploy edge functions. Postgres backups. Generating types from your database schema.
Overview of cli
What it is
Supabase CLI is a command-line tool that brings the Supabase Platform to your terminal. It allows developers to manage Postgres migrations, run the full local Supabase stack, deploy Edge Functions, generate TypeScript types from database schemas, and automate project workflows.
Key features
- Manage Postgres migrations (create, diff, push, reset) on local or linked remote projects
- Run the full local Supabase stack including Postgres, Auth, Realtime, Storage, Edge Functions, and APIs
- Deploy Edge Functions from the same project workspace
- Generate TypeScript types from local or remote database schemas
- Link a local workspace to a hosted Supabase project
- Create a new Supabase workspace with
supabase initand start from a template withsupabase bootstrap
Use cases
- Local development and testing of Supabase projects before deploying to production
- Managing database schema changes through version-controlled migrations
- Deploying and serving serverless Edge Functions
- Generating type-safe TypeScript definitions from database schemas
- Automating project workflows and CI/CD pipelines
Getting started
sh# Install via npmnpm install -D supabase# Or via Homebrew (macOS/Linux)brew install supabase/tap/supabase# Or via Scoop (Windows)scoop bucket add supabase https://github.com/supabase/scoop-bucket.gitscoop install supabase# Then initialize and start local developmentsupabase initsupabase startsupabase status
License and pricing
The Supabase CLI packages are released under the MIT license. The pricing type is open source.
Based on the project's public README and repository metadata.