Skip to content

Using the CLI

The dbdev CLI can be used for:

  • Installing TLEs from [database.dev] or your local machine.
  • Updating TLEs from [database.dev] or your local machine.
  • Publishing TLEs to database.dev.

Installation

Installation is available through a native package, binary download or building from source.

Native Package

Install the CLI with Homebrew: 

1
brew install supabase/tap/dbdev

Install the CLI with Homebrew: 

1
brew install supabase/tap/dbdev

Linux packages

Debian Linux packages are provided in Releases. To install, download the .deb file and run the following:

1
sudo dpkg -i <...>.deb

Install the CLI with Scoop. 

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

Upgrading

Use dbdev --version to check if you are on the latest version of the CLI.

Native Package

Upgrade the CLI with Homebrew: 

1
brew upgrade dbdev

Install the CLI with Homebrew: 

1
brew upgrade dbdev

Linux packages

Debian Linux packages are provided in Releases. To upgrade, download the .deb file and run the following:

1
sudo dpkg -i <...>.deb

Update the CLI with Scoop. 

1
scoop update dbdev

Binary Download

Binaries for dbdev CLI are available for Linux, Windows and macOS platforms. Visit the dbdev releases page to download a binary for your OS. The downloaded binary should be placed in a folder which is in your PATH.

Build From Source

Alternatively, you can build the binary from source. You will need to have Rust installed on your system. To build from source:

  1. Clone the repo: git clone https://github.com/supabase/dbdev.git.
  2. Change directory to dbdev: cd dbdev.
  3. Build: cargo install --release.
  4. Copy the dbdev binary in target/release to a folder in your PATH.

If you have cargo-install, you can perform all the above steps with a single command: cargo install --git https://github.com/supabase/dbdev.git dbdev.

Now you're ready to publish your first package.