Budibase CLI setup

The Budibase CLI is how you initialise, manage and update your Budibase installation.

🚧

You must have Docker before installing the Budibase CLI

The Budibase CLI makes running a docker self-hosted installation easier. To use the CLI you must first install Docker.

Downloading Budibase CLI

If you have NodeJS installed, you can follow the recipe below:

Or simply run the following to install the Budibase CLI:

yarn global add @budibase/cli
npm i -g @budibase/cli

Alternatively, you can just download the Budibase CLI for your operating system here:

If you do download from the above links, the steps are slightly different compared to downloading the CLI from NPM. After downloading the CLI, you will have to make it executable. Let's take the cli-linux for example:

# optional - if you have already downloaded this just navigate to the file
wget https://github.com/Budibase/budibase/releases/latest/download/cli-linux

chmod +x cli-linux

# optional - rename to budi
mv cli-linux budi

When following the rest of this guide, when you see the budi command being used, you will need to replace it with:

./budi

Running Budibase

Once the CLI is installed, navigate to the directory where you would like to store the files for your Budibase installation, and run:

budi hosting --init # or ./cli-linux hosting --init
? This will create multiple files in the current directory, should continue? Yes

# Feel free to configure your port
? Please enter the port on which you want your installation to run:  10000

The configuration has been written successfully - please check the .env file for more details.

📘

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

First Time Budibase Setup

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

budi hosting --start

You will then see:

Starting services, this may take a moment.
Services started, please go to http://localhost:10000 for next steps.

Updating Budibase

To update the services with the latest docker images, use the following command:

budi hosting --update

Did this page help you?