Installing the Global CLI

This document provides installation instructions for the bolt-cli.

Prerequisites

Node.js (version 18.0.0 or higher)
Package Manager (e.g., NPM or Yarn)
Docker CLI (> Docker version 24.0.2, build cb74dfc)
fswatch (>= 1.17.1)
QEMU emulator (version >= 8.0.2)

Notes: • You will need Docker CLI if and only if you are using Docker Service Runner • You will need QEMU emulator if and only if you are using VM Project Runner • You will need fswatch if and only if you are using VM Project Runner • Bolt Virtual Machine currently supports only Apple Silicon Chip

Installation Steps

In order to install bolt-cli in your system you can either use yarn or npm to install the package.

# using npm

npm install --global @gluestack/bolt@latest

# using yarn

yarn global add @gluestack/bolt@latest

After the installation is complete, you can check if the package is installed correctly by running the following command in your terminal.

bolt

If it's installed correctly it should give the output something like this:

Usage: Bolt [options] [command]

Bolt CLI tool <VERSION_NUMBER>

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  init [options]  Inits the project with bolt.yaml file
  help [command]  display help for command

Up next

Your First Bolt Project

Your First Bolt Project