@little-dash/cli

Developer CLI for littledash smart displays. Live preview, device tools, and project scaffolding.

npm install -g @little-dash/cli

Commands

littledash dev [target]

Open a live preview of a running littledash app in a small standalone window.

littledash dev                  # previews localhost:3000
littledash dev localhost:4000
littledash dev 192.168.1.10:3000

The preview renders the app's /display response pixel-for-pixel like the device (same 5x7 pixel font, icons, built-in bitmaps, and on-device animations), and has controls for:

• manual refresh (R) and pausing/resuming auto-refresh (A)
• refresh interval override (or follow the app's refreshInterval)
• rotation (T) and zoom

It opens in a Chromium --app window when Chrome/Edge/Brave/Chromium is installed, otherwise in your default browser. Use --no-open to just run the preview server, --port to pin its port.

littledash device list

List littledash devices connected via USB. Each device is probed over serial for its configured app server, WiFi state, IP, and battery.

littledash device list
littledash device list --no-probe   # just list ports, don't talk to them
littledash device list --all        # include ports that don't look like devices
littledash device list --json       # machine-readable output

littledash device configure [serverUrl]

Configure a connected device: WiFi credentials, the app server URL (your local IP is auto-detected if omitted), and any variables the app's /variables endpoint asks for.

littledash device configure                  # auto-detect IP:3000
littledash device configure 192.168.1.10:4000
littledash device configure --wifi           # scan for networks from the device

littledash device monitor

Interactive serial monitor. Prints device logs and lets you type firmware commands (help, status, config, battery, …).

littledash init [dir]

Scaffold a new littledash app — an Express server with a starter display.

littledash init my-dash
cd my-dash
npm install
npm run dev

Then edit src/display.ts and watch it live with littledash dev.

Development (in the monorepo)

yarn workspace @little-dash/cli build
node packages/littledash-cli/dist/index.js --help

assets/ holds copies of the firmware's pixel fonts and built-in bitmaps so the preview matches the panel; refresh them with yarn workspace @little-dash/cli assets:sync after changing firmware fonts or bitmaps.