Skip to content
Chris Obdam edited this page Jan 16, 2023 · 43 revisions

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.

Getting started

Prerequisites

As of version 25.29.0, you will need to install the requirements for IsolatedVM which include:

  • make

  • g++

  • python

Installation

To install the CLI globally you will need a recent version of Node.js.

$ npm install -g @betty-blocks/cli

To install the CLI without optional dependencies (isolated-vm)

$ npm install -g @betty-blocks/cli --no-optional

Update

$ npm update -g @betty-blocks/cli

To update the CLI without optional dependencies (isolated-vm)

$ npm update -g @betty-blocks/cli --no-optional

Version

$ bb --version

Starting your local development server

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

$ npm 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
  functions [cmd]     manage your custom functions
  interactions [cmd]  manage your interactions
  bundle [cmd]        manage your vendor bundle
  help [cmd]          display help for [cmd]
  • 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.

Clone this wiki locally