CLI overview

@v5x/cli is a Bun-powered command-line interface for the complete local development loop.

v5x build
v5x upload --slot 2
v5x run --slot 2

Command groups

Project commands

Create, build, clean, upload, and run programs.

Brain commands

Inspect devices, files, screenshots, program output, and system values.

Run v5x <command> --help for the exact syntax of your installed version.

JSON errors

Commands that support --json also return machine-readable failures. A failure is written to standard error as one JSON object and the command exits with its existing non-zero status:

{ "error": { "message": "no V5 device found", "exitCode": 3 } }

The stable error object contains:

message: a human-readable description of the failure.
exitCode: the same numeric status returned by the process.

Serial error kinds and stack traces are not included, including when --verbose or V5X_DEBUG=1 is set. Without --json, failures retain their human-readable format and --verbose continues to show stack traces.

Install the CLI

CLI overview - v5x

​Command groups

Project commands

Brain commands

​JSON errors

Command groups

JSON errors