Home - bettyblocks/cli GitHub Wiki

Introduction

Welcome to the GitHub repository for the Betty Blocks command-line interface (CLI).

This CLI lets you develop Page Builder Components & Interactions and Action Functions, for Betty Blocks, a no-code platform for business users. Not using Betty Blocks yet? Find out more at https://www.bettyblocks.com.

Two different features of the CLI

With this CLI you can create two different types of elements for the Betty Blocks platform.

• Page Builder Components
• Action Functions

Getting started

Prerequisites

As of version 26, you will need to install the following requirements

• bun

Installation

To install the CLI globally, use the following command:

$ npm install -g @betty-blocks/cli

Updating

To update the CLI globally, use the following command:

$ npm update -g @betty-blocks/cli

Version

$ bb --version

Starting your local development server

Go to the folder where you're developing a component and start the server.

$ bun run dev

Usage

After install, you will have access to the bb command in your terminal.

Use bb help to get a list of available commands.

$ bb help

Usage: bb [options] [command]

Betty Blocks CLI

Options:
  -v, --version       output the version number
  -h, --help          output usage information

Commands:
  components [cmd]  manage your component sets
  blocks [cmd]      manage your blocks
  functions [cmd]   manage your custom functions
  bundle [cmd]      manage your vendor bundle
  help [command]    display help for command

• To get started with components visit this link
• To get started with functions visit this link

Note!

The ApplicationFunctions use the same bb functions namespace that CustomFunctions use. ApplicationFunctions will eventually replace the CustomFunctions. Once a project is initialised, the CLI will be aware of the differentation and will automatically handle the commands accordingly.