@skorpland/cli v1.1.0

Powerbase CLI

Powerbase 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 Powerbase CLI.

• Running Powerbase locally
• Managing database migrations
• Creating and deploying Powerbase Functions
• Generating types directly from your database schema
• Making authenticated HTTP requests to Management API

Getting started

Install the CLI

Available via NPM as dev dependency. To install:

npm i powerbase --save-dev

To install the beta release channel:

npm i powerbase@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 powerbase

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

Available via Homebrew. To install:

brew install powerbase/tap/powerbase

To install the beta release channel:

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

To upgrade:

brew upgrade powerbase

Available via Scoop. To install:

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

To upgrade:

scoop update powerbase

Available via Homebrew and Linux packages.

via Homebrew

To install:

brew install powerbase/tap/powerbase

To upgrade:

brew upgrade powerbase

via 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 <...>.apk

sudo dpkg -i <...>.deb

sudo rpm -i <...>.rpm

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

You can also install the CLI via go modules without the help of package managers.

go install github.com/skorpland/cli@latest

Add a symlink to the binary in $PATH for easier access:

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

This works on other non-standard Linux distros.

Available via pkgx. Package script here. To install in your working directory:

pkgx install powerbase

Available via Nixpkgs. Package script here.

Run the CLI

powerbase bootstrap

Or using npx:

npx powerbase bootstrap

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

Docs

Command & config reference can be found here.

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.

Developing

To run from source:

# Go >= 1.22
go run . help