Git Product home page Git Product logo

cli's Introduction

Supabase CLI (v1)

Coverage Status

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

NodeJS

Available via NPM as dev dependency. To install:

npm i supabase --save-dev

To run:

npx supabase -h

macOS

Available via Homebrew. To install:

brew install supabase/tap/supabase

To upgrade:

brew upgrade supabase

Windows

Available via Scoop and Chocolatey.

via Chocolatey

To install:

choco install supabase

To upgrade:

choco upgrade supabase
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

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.18
go run . help

Sponsors

New Sponsor

cli's People

Contributors

soedirgo avatar sweatybridge avatar dependabot[bot] avatar laktek avatar awalias avatar darora avatar kangmingtay avatar w3b6x9 avatar egor-romanov avatar grschafer avatar kandros avatar theo-m avatar osaxma avatar thorwebdev avatar snorremd avatar wilhuff avatar felixzy avatar burmecia avatar akoenig avatar mclean25 avatar maxkostow avatar isaif avatar natonathan avatar nixbiks avatar paulrosset avatar zlepper avatar yahsan2 avatar sorakumo001 avatar vbaluch avatar madx avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.