This is a fork of the Supabase CLI with custom modifications for the noTreeTeam organization.

• Custom Postgres Image: Uses ghcr.io/notreeteam/postgres:latest instead of the default Supabase Postgres image
• Published to GitHub Packages: Available as @notreeteam/supabase-cli on GitHub Packages
• Automated Releases: Regularly updated to track upstream changes

1. Create or update your .npmrc file to configure the GitHub Packages registry:

@notreeteam:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN

2. Generate a GitHub Personal Access Token with read:packages scope at: https://github.com/settings/tokens

3. Install the package:

npm install @notreeteam/supabase-cli --save-dev

4. Use the CLI:

npx supabase --help

Alternatively, you can install directly from the GitHub repository:

{
  "devDependencies": {
    "supabase": "github:noTreeTeam/cli"
  }
}

Available via NPM 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

You can override the GitHub repository and release used by the installer by setting environment variables. Specify SUPABASE_REPO for the repository and SUPABASE_VERSION for the tag name (use latest to fetch the most recent release):

SUPABASE_REPO=myorg/cli SUPABASE_VERSION=latest npm i github:myorg/cli --save-dev

Alternatively, reference the GitHub repository directly in your package.json to keep the CLI local to your project:

{
  "devDependencies": {
    "supabase": "github:myorg/cli"
  }
}

Then run npm install and access the CLI via npx supabase.

Note For Bun versions below v1.0.17, you must add supabase as a trusted dependency before running bun add -D supabase.

brew install supabase/tap/supabase

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

brew upgrade supabase

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

scoop update supabase

brew install supabase/tap/supabase

brew upgrade supabase

sudo apk add --allow-untrusted <...>.apk

sudo dpkg -i <...>.deb

sudo rpm -i <...>.rpm

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

go install github.com/noTreeTeam/cli@latest

ln -s "$(go env GOPATH)/bin/cli" /usr/bin/supabase

pkgx install supabase

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 the starter templates.

Use the bundled action to install the CLI from any GitHub repository. Default repository is noTreeTeam/cli so the action can replace the official setup step.

steps:
  - uses: actions/checkout@v4
  - uses: ./.github/actions/setup-cli
    with:
      repo: <owner>/<repo>
      version: latest
  - run: supabase --version

Command & config reference can be found here.

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.

To run from source:

# Go >= 1.22
go run . help