Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (supabase) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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
Available via NPM as dev dependency. To install:
npm i supabase --save-devTo install the beta release channel:
npm i supabase@beta --save-devNote For Bun users, you must add
supabaseas a trusted dependency before runningbun add -D supabase.
macOS
Available via Homebrew. To install:
brew install supabase/tap/supabaseTo install the beta release channel:
brew install supabase/tap/supabase-beta
brew link --overwrite supabase-betaTo 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/.pkg.tar.zst file depending on your package manager and run the respective commands.
sudo apk add --allow-untrusted <...>.apksudo dpkg -i <...>.debsudo rpm -i <...>.rpmsudo pacman -U <...>.pkg.tar.zstOther Platforms
You can also install the CLI via go modules without the help of package managers.
go install github.com/supabase/cli@latest Add a symlink to the binary in $PATH for easier access:
ln -s "$(go env GOPATH)/cli" /usr/bin/supabaseThis works on other non-standard Linux distros.
Community Maintained Packages
Available via pkgx. Package script here. To install in your working directory:
pkgx install supabaseRun the CLI
supabase helpOr using npx:
npx 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.20
go run . help