supabase/cliPublic

NotificationsYou must be signed in to change notification settings
Fork308
Star1.5k

Supabase CLI. Manage postgres migrations, run Supabase locally, deploy edge functions. Postgres backups. Generating types from your database schema.

License

MIT license

1.5k stars 308 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 3,725 Commits
.github		.github
api		api
cmd		cmd
docs		docs
examples		examples
internal		internal
pkg		pkg
scripts		scripts
tools		tools
.gitignore		.gitignore
.golangci.yml		.golangci.yml
.goreleaser.yml		.goreleaser.yml
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
go.mod		go.mod
go.sum		go.sum
main.go		main.go
package.json		package.json

Repository files navigation

Supabase CLI

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
Creating and deploying Supabase Functions
Generating types directly from your database schema
Making authenticated HTTP requests toManagement API

Getting started

Install the CLI

Available viaNPM as dev dependency. To install:

npm i supabase --save-dev

To install the beta release channel:

npm i supabase@beta --save-dev

When installing with yarn 4, you need to disable experimental fetch with the following nodejs config.

NODE_OPTIONS=--no-experimental-fetch yarn add supabase

NoteFor Bun versions below v1.0.17, you must addsupabase as atrusted dependency before runningbun add -D supabase.

macOS

Available viaHomebrew. To install:

brew install supabase/tap/supabase

To install the beta release channel:

brew install supabase/tap/supabase-betabrew link --overwrite supabase-beta

To upgrade:

brew upgrade supabase

Windows

Available viaScoop. To install:

scoop bucket add supabase https://github.com/supabase/scoop-bucket.gitscoop install supabase

To upgrade:

scoop update supabase

Linux

Available viaHomebrew and Linux packages.

via Homebrew

To install:

brew install supabase/tap/supabase

To upgrade:

brew upgrade supabase

via Linux packages

Linux packages are provided inReleases. 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<...>.apk

sudo dpkg -i<...>.deb

sudo rpm -i<...>.rpm

sudo pacman -U<...>.pkg.tar.zst

Other Platforms

You can also install the CLI viago 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)/bin/cli" /usr/bin/supabase

This works on other non-standard Linux distros.

Community Maintained Packages

Available viapkgx. Package scripthere.To install in your working directory:

pkgx install supabase

Available viaNixpkgs. Package scripthere.

Run the CLI

supabase bootstrap

Or using npx:

npx supabase bootstrap

The bootstrap command will guide you through the process of setting up a Supabase project using one of thestarter templates.

Docs

Command & config reference can be foundhere.

Breaking changes

We follow semantic versioning for changes that directly impact CLI commands, flags, and configurations.

However, due to dependencies on other service images, we cannot guarantee that schema migrations, seed.sql, and generated types will always work for the same CLI major version. If you need such guarantees, we encourage you to pin a specific version of CLI in package.json.