Skip to main content
Version: Next

Set up your environment

In this guide, we will install the BlueScript CLI and flash the runtime environment to your microcontroller.

Currently, only ESP32 development boards are supported.

Prerequisites​

Before we begin, ensure you have the following:

  • Hardware:
    • Host PC: A laptop running macOS (Windows and Linux are currently not supported).
    • Micocontroller: An ESP32 development board (e.g., ESP32-DevKitC)
    • USB cable to connect your host PC and the microcontroller
  • Software
    • Node.js (v20 or later) installed on your host PC.

Step 1: Install the CLI​

BlueScript provides a command-line interface (CLI) to manage projects and communicate with your device. Install it globally using npm:

npm install -g @bscript/cli

Verify the installation:

bscript --version

Step 2: Board Setup​

Because BlueScript uses a Disaggregated VM architecture, you need to install the lightweight Runtime onto your microcontroller.

One-Time Setup

The USB cable is only required for this step (flash-runtime). Once this is done, you can disconnect the cable and use Bluetooth for daily development.

1. Download Platform Tools​

Download the necessary environment files for the ESP32 platform:

bscript board setup esp32

Note: Currently, only esp32 is supported.

2. Flash the Runtime​

Connect your ESP32 to your computer via USB and flash the runtime:

bscript board flash-runtime esp32

If the flash is successful, your device is now ready to receive BlueScript code wirelessly!

Next Steps​

Now that your device is set up, let's create your first project.

👉 Go to: Create project and Run