Budibase CLI Install

The Budibase CLI tool can be used to create a new Budibase installation, to manage an existing installation, make backups or update a Budibase installation to a new version. The video below summarises the tool with further instructions below.

Install Budibase CLI

Prerequisites

You should ensure you have Node and Docker installed on your system. An example is shown below for Linux (Debian/Ubuntu). On MacOSX consider using brew and on Windows consider using chocolatey.

# These commands can be used to install the Budibase CLI on a debian/ubuntu distribution
sudo apt install docker.io
curl -sL https://deb.nodesource.com/setup_14.x | sudo bash -
npm install -g @budibase/cli
budi --version

Install Budibase CLI with NPM

If you already have NodeJS version 14+ on your system you can install the Budibase CLI tool with NPM as shown below. A yarn alternative is shown for those who prefer to use yarn:

npm install -g @budibase/cli

yarn global add @budibase/cli

Manual Install of Budibase CLI

As an alternative to using NPM to install the Budibase CLI tool you can also download a binary version of the tool for your operating system:

• Windows
• Mac
• Linux

On Linux and Mac you will also need to make this manually downloaded version executable and add it to your path e.g.:

# download the linux version of the tool
wget https://github.com/Budibase/budibase/releases/latest/download/cli-linux

# make the tool executable
chmod +x cli-linux

# rename and move to a global path
sudo mv cli-linux /usr/local/bin/budi

Budibase CLI Usage

Regardless of the installation method you used above you should now be able to run the budi command as shown below. If not you should go over the installation instructions again.

budi help

You should see output similar to this:

Install Budibase using the Budibase CLI

Use the following command to generate a .env file containing the secrets to be used when you start your budibase installation:

budi hosting --init

The commands below can be viewed in this recipe if desired:

You can view, copy or backup your .env file at this point:

You can now start the Budibase services with the following command:

budi hosting --start

After a little time you will be able to view the running docker containers with:

docker ps
docker-compose ps

And you should be able to access Budibase over HTTP on the port number you chose during initialisation e.g. http://127.0.0.1:10000

Update Budibase Version using the Budibase CLI

To update the services with the latest docker images, use the following comman

budi hosting --update

Backing Up Data using the Budibase CLI

This command can be run from within the same directory as your Budibase .env file:

budi backups --export --env .env

For more see the Backupshttps://docs.budibase.com/docs/backups section.

 ARM

📘

If you have an ARM based CPU, you will have to make a slight update to your docker-compose.yaml . Update the couchdb-service part of your compose config as follows:

couchdb-service:
    platform: linux/amd64
    ...