Supabase CLI (v1)
Supabase is an open source Firebase alternative. We're building the features of Firebase using enterprise-grade open source tools.
This repository contains all the functionality for Supabase CLI.
- Running Supabase locally
- Managing database migrations
- Pushing your local changes to production
- Create and Deploy Supabase Functions
- Manage your Supabase Account
- Manage your Supabase Projects
- Generating types directly from your database schema
- Generating API and validation schemas from your database
Getting started
Install the CLI
NodeJS
Available via NPM. To install:
npm i supabaseTo run:
npx supabase -hmacOS
Available via Homebrew. To install:
brew install supabase/tap/supabaseTo upgrade:
brew upgrade supabaseWindows
Available via Scoop. To install:
scoop bucket add supabase https://github.com/supabase/scoop-bucket.git
scoop install supabaseTo upgrade:
scoop update supabaseLinux
Available via Homebrew and Linux packages.
via Homebrew
To install:
brew install supabase/tap/supabaseTo upgrade:
brew upgrade supabasevia Linux packages
Linux packages are provided in Releases. To install, download the .apk/.deb/.rpm file depending on your package manager and run the respective commands.
sudo apk add --allow-untrusted <...>.apksudo dpkg -i <...>.debsudo rpm -i <...>.rpmOther Platforms
You can also install the CLI via go modules without the help of package managers.
go install github.com/supabase/cli@latestAdd a symlink to the binary in $PATH for easier access:
ln -s "$(go env GOPATH)/cli" /usr/bin/supabaseThis works on non-standard linux distros, like archlinux.
Run the CLI
supabase helpDocs
Command & config reference can be found here.
Breaking changes
The CLI is a WIP and we're still exploring the design, so expect a lot of breaking changes. We try to document migration steps in Releases. Please file an issue if these steps don't work!
Developing
To run from source:
# Go >= 1.18
go run . helpSponsors
