github.com/Redstoneguy129/cli@v0.0.0-20230211220159-15dca4e91917/README.md (about) 1 # Supabase CLI (v1) 2 3 [![Coverage Status](https://coveralls.io/repos/github/Redstoneguy129/cli/badge.svg?branch=main)](https://coveralls.io/github/Redstoneguy129/cli?branch=main) 4 5 [Supabase](https://supabase.io) is an open source Firebase alternative. We're building the features of Firebase using enterprise-grade open source tools. 6 7 This repository contains all the functionality for Supabase CLI. 8 9 - [x] Running Supabase locally 10 - [x] Managing database migrations 11 - [x] Pushing your local changes to production 12 - [x] Create and Deploy Supabase Functions 13 - [ ] Manage your Supabase Account 14 - [x] Manage your Supabase Projects 15 - [x] Generating types directly from your database schema 16 - [ ] Generating API and validation schemas from your database 17 18 ## Getting started 19 20 ### Install the CLI 21 22 #### NodeJS 23 24 Available via [NPM](https://www.npmjs.com) as dev dependency. To install: 25 26 ```bash 27 npm i supabase --save-dev 28 ``` 29 30 To run: 31 32 ```bash 33 npx supabase -h 34 ``` 35 36 #### macOS 37 38 Available via [Homebrew](https://brew.sh). To install: 39 40 ```sh 41 brew install supabase/tap/supabase 42 ``` 43 44 To upgrade: 45 46 ```sh 47 brew upgrade supabase 48 ``` 49 50 #### Windows 51 52 Available via [Scoop](https://scoop.sh). To install: 53 54 ```powershell 55 scoop bucket add supabase https://github.com/supabase/scoop-bucket.git 56 scoop install supabase 57 ``` 58 59 To upgrade: 60 61 ```powershell 62 scoop update supabase 63 ``` 64 65 #### Linux 66 67 Available via [Homebrew](https://brew.sh) and Linux packages. 68 69 ##### via Homebrew 70 71 To install: 72 73 ```sh 74 brew install supabase/tap/supabase 75 ``` 76 77 To upgrade: 78 79 ```sh 80 brew upgrade supabase 81 ``` 82 83 ##### via Linux packages 84 85 Linux packages are provided in [Releases](https://github.com/Redstoneguy129/cli/releases). To install, download the `.apk`/`.deb`/`.rpm`/`.pkg.tar.zst` file depending on your package manager and run the respective commands. 86 87 ```sh 88 sudo apk add --allow-untrusted <...>.apk 89 ``` 90 91 ```sh 92 sudo dpkg -i <...>.deb 93 ``` 94 95 ```sh 96 sudo rpm -i <...>.rpm 97 ``` 98 99 ```sh 100 sudo pacman -U <...>.pkg.tar.zst 101 ``` 102 103 #### Other Platforms 104 105 You can also install the CLI via [go modules](https://go.dev/ref/mod#go-install) without the help of package managers. 106 107 ```sh 108 go install github.com/Redstoneguy129/cli@latest 109 ``` 110 111 Add a symlink to the binary in `$PATH` for easier access: 112 113 ```sh 114 ln -s "$(go env GOPATH)/cli" /usr/bin/supabase 115 ``` 116 117 This works on other non-standard Linux distros. 118 119 ### Run the CLI 120 121 ```sh 122 supabase help 123 ``` 124 125 ## Docs 126 127 Command & config reference can be found [here](https://supabase.com/docs/reference/cli/about). 128 129 ## Breaking changes 130 131 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](https://github.com/Redstoneguy129/cli/releases). Please file an issue if these steps don't work! 132 133 ## Developing 134 135 To run from source: 136 137 ```sh 138 # Go >= 1.18 139 go run . help 140 ``` 141 142 --- 143 144 ## Sponsors 145 146 [![New Sponsor](https://user-images.githubusercontent.com/10214025/90518111-e74bbb00-e198-11ea-8f88-c9e3c1aa4b5b.png)](https://github.com/sponsors/supabase)