The budibase CLI is an all in one toolkit for managing your budibase self hosted installation. These API docs detail all of the commands and flags available to you when using the CLI.
Pre-requisite: CLI installed and ready to use
This guide assumes that you have installed and used the Budibase CLI before, if you have not then you can follow our guide on installing the Budibase CLI.
Initialise and manage a self hosted budibase installation. Currently only supports docker compose setups.
You must be in the same directory that you ran --init to use the budibase CLI commands
budi hosting --init, you must be in the directory where budibase was initialised to use the other
|Initialise a self hosted docker compose budibase setup in current directory. Pulls images and everything required to start the budibase server.|
|Start the budibase services.|
|Check the current status of all the running budibase services.|
|Stop all the currently running budibase services|
budi hosting --init
budi hosting --start
budi hosting --status
budi hosting --stop
budi plugins is the CLI command used for creating, developing and managing custom coded components and datasources. You can find tutorials on how to create components and datasources below.
|Pull down the budibase project skeleton for a datasource or component, and initialise it in the current working directory.|
|Build the datasource or component in the current working directory using rollup, so it can be used inside the budibase platform.|
|Watch the component/datasource in the current working directory and automatically rebuild when changes are made.|
# datasource budi plugins --init datasource # component budi plugins --init component
budi plugins --build
budi plugins --watch
budi backups is a CLI command that allows you to completely backup and restore your self hosted budibase installation.
- Save backups as
.tar.gzfiles that you can store elsewhere
- Import the
.tar.gzfiles to a fresh budibase system to restore to the state of your backup.
You can find a full end to end tutorial on using the
budi backups CLI command here:
You need to provide credentials to the budi backups command
If you do not pass the
budi backupscommands, you will have to answer a set of questions in the CLI to pass the credentials required to perform import and export of backups. The required variables are:
Full URL for your running CouchDB service. Must include credentials.
MinIO/S3 compatible object store access key
MinIO/S3 compatible object store secret key
URL on which your MinIO/S3 compatible object store is running on.
The port your budibase instance is hosted on. Defaults to 10000.
|Export your budibase installation, apps and configuration to a |
|Import a |
|Pass a path to an |
budi backups --export --env /path/to/env/file
budi backups --import mybackup.tar.gz --env /path/to/env/file
COUCH_DB_URL=http://admin:admin@localhost:10000/db/ MINIO_ACCESS_KEY=mykey MINIO_SECRET_KEY=mysecret MINIO_URL=http://localhost:10000 MAIN_PORT=10000
This command is for opting in/out of budibase CLI analytics.
|Opt in to budibase CLI analytics.|
|Opt out of budibase CLI analytics.|
budi analytics --optIn
budi analytics --optOut
Updated 7 months ago