esp-brookesia-toolkit
v0.1.12
Published
CLI and PC simulator for ESP-Brookesia JavaScript/Lua/Wasm app package development
Maintainers
Readme
CLI for building, packaging, verifying, and simulating ESP-Brookesia app packages (.bpk).
Install
pnpm install -g esp-brookesia-toolkit
brookesia --helpQuick Start
brookesia init my-app --template js-gui
cd my-app
pnpm install
brookesia build
brookesia simulate --target systemCommands
| Command | Description |
| ------------------- | ---------------------------------------- |
| init <name> | Scaffold a new project from a template |
| doctor | Check environment and simulator binaries |
| build | Dev build → debug .bpk |
| release | Release build → signed .bpk |
| sign init | Generate signing keys |
| pack | Pack directory into .bpk |
| verify <file.bpk> | Verify release signature |
| simulate | Run app in WASM browser simulator |
| dev | Start Settings GUI simulator |
Templates
| Template | Description |
| ----------- | ------------------------------------- |
| js-gui | JavaScript + LVGL GUI (default) |
| js-bundle | JavaScript bundled via rspack/webpack |
| lua-gui | Lua + LVGL GUI |
| wasm-gui | WebAssembly + LVGL GUI |
Simulator
brookesia simulate --target system runs your .bpk in a WASM-based browser simulator.
Flags: --smoke, --gui-debug, --resolution WxH, --duration-ms N.
Links
- Monorepo: esp-brookesia-toolkit
- Firmware SDK: esp-brookesia
- Example apps: esp-brookesia-apps
- npm:
@brookesia/*
