supabase/cli

Stars
849
Rank 51,483 (Top 2 %)
Language
Go
License
MIT License
Created over 3 years ago
Updated 8 days ago

supabase/cli

supabase

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

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

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-dev

To install the beta release channel:

npm i supabase@beta --save-dev

macOS

Available via Homebrew. To install:

brew install supabase/tap/supabase

To install the beta release channel:

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

To upgrade:

brew upgrade supabase

Windows

Available via Scoop. To install:

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

To upgrade:

scoop update supabase

Linux

Available via Homebrew and Linux packages.

via Homebrew

To install:

brew install supabase/tap/supabase

To upgrade:

brew upgrade supabase

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

Other 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/supabase

This works on other non-standard Linux distros.

Run the CLI

supabase help

Or using npx:

npx supabase help

Docs

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

supabase

The open source Firebase alternative.

realtime

Broadcast, Presence, and Postgres Changes via WebSockets

postgres_lsp

A Language Server for Postgres

supabase-js

An isomorphic Javascript client for Supabase. Query your Supabase database, subscribe to realtime events, upload and download files, browse typescript examples, invoke postgres functions via rpc, invoke supabase edge functions, query pgvector.

pg_graphql

GraphQL support for PostgreSQL

supavisor

A cloud-native, multi-tenant Postgres connection pooler.

ui

Supabase UI Library

postgres

Unmodified Postgres with some useful plugins

index_advisor

PostgreSQL Index Advisor

auth

A JWT based API for managing users and issuing JWT tokens

pg_jsonschema

PostgreSQL extension providing JSON Schema validation

postgrest-js

Isomorphic JavaScript client for PostgREST.

auth-helpers

A collection of framework specific Auth utilities for working with Supabase.

postgres-meta

A RESTful API for managing your Postgres. Fetch tables, add roles, and run queries

storage

S3 compatible object storage service that stores metadata in Postgres

supabase-flutter

Flutter integration for Supabase. This package makes it simple for developers to build secure and scalable products.

supa_audit

Generic Table Auditing

supabase-swift

A Swift client for Supabase

edge-runtime

A server based on Deno runtime, capable of running JavaScript, TypeScript, and WASM services.

stripe-sync-engine

Sync your Stripe account to you Postgres database.

wrappers

Postgres Foreign Data Wrapper development framework in Rust.

auth-ui

Pre-built Auth UI for React

supabase-dart

A Dart client for Supabase

pg_crdt

POC CRDT support in Postgres

dbdev

Database Package Registry for Postgres

auth-js

An isomorphic Javascript library for Supabase Auth.

realtime-js

An isomorphic Javascript client for Supabase Realtime server.

examples-archive

Supabase Examples Archive

pg_netstat

PostgreSQL extension to monitor database network traffic

grid

A react component to display your Postgresql table data. Used in Supabase Dashboard app.

vecs

Postgres/pgvector Python Client

libcluster_postgres

Postgres strategy for libcluster

pg_net

A PostgreSQL extension that enables asynchronous (non-blocking) HTTP/HTTPS requests with SQL

vault

Extension for storing encrypted secrets in the Vault

postgrest-dart

Dart client for PostgREST

headless-vector-search

Supabase Toolkit to perform vector similarity search on your knowledge base embeddings.

workflows

supabase-grafana

Observability for your Supabase project, using Prometheus/Grafana

walrus

Applying RLS to PostgreSQL WAL

storage-js

JS Client library to interact with Supabase Storage

postgres-deno

A PostgreSQL extension for Deno: run Typescript in PostgreSQL functions and triggers.

realtime-dart

A dart client for Supabase Realtime server.

setup-cli

A GitHub action for interacting with your Supabase projects using the CLI.

repository.surf

embeddings-generator

GitHub Action to generate embeddings from the markdown files in your repository.

supabase-ui-web

self-hosted-edge-functions-demo

A demo of how to self-host Supabase Edge Functions on Fly.io

functions-js

supabase-admin-api

API to administer the Supabase server (KPS)

supautils

PostgreSQL extension that secures a cluster on a cloud environment

gotrue-dart

A dart client library for GoTrue.

supabase-action-example

benchmarks

grafana-agent-fly-example

Deploy a Grafana Agent on Fly to scrape Prometheus metrics from Supabase and send them to Grafana Cloud

functions-relay

API Gateway for Supabase Edge functions

nix-postgres

Experimental port of supabase/postgres to Nix

benchmarks-archive

Infrastucture benchmarks

hibp

Go library for HaveIBeenPwned.org's pwned passwords API.

splinter

Supabase Postgres Linter

supabase.ai

storage-dart

Dart client library to interact with Supabase Storage

livebooks

A collection of Elixir Livebooks for Supabase

base64url-js

Pure TypeScript implementation of Base64-URL encoding for JavaScript strings.

terraform-provider-supabase

orb-sync-engine

.github

Org-wide default community health files & templates.

auth-elements

Components to add Supabase Auth to any application

rfcs

functions-dart

test-reports

Repository to store test reports data and host reporting in gh-pages

plug_caisson

An Elixir Plug library for handling compressed requests

flyswatter

Deploy a global pinger on Fly

scoop-bucket

tests

pgextkit

homebrew-tap

fly-preview

shared-types

supa_type

The Missing PostgreSQL Data Types

test-inspector

Check your test results against the reference run and compare coverage for multiple client libraries

mailme

A clone of Netlify's mailme package used in Supabase Auth / GoTrue.

productions

Supabase SynthWave. The best soundtrack to build an app in a weekend and scale to billions.

design-tokens