@v5x/cli 0.0.23 → 0.0.24

package/README.md

@@ -6,6 +6,12 @@ See the [complete CLI documentation](https://docs.v5x.dev/cli/overview) for work
 
 ## Install
 
+```sh
+curl -fsSL https://v5x.dev/install.sh | sh
+```
+
+Alternatively, install the package with Bun 1.3.14 or newer:
+
 ```sh
 bun add --global @v5x/cli
 ```
@@ -14,8 +20,8 @@ The CLI supports PROS, vexide, and VEXcode C++ projects. The corresponding
 compiler toolchain must be installed before building a project.
 
 The current CLI release supports Linux and macOS, matching the package
-metadata's `os` field. Bun 1.3.14 or newer is required. Windows is not
-published yet because the CLI needs a compatible serial backend there.
+metadata's `os` field. Windows is not published yet because the CLI needs a
+compatible serial backend there.
 For browser integrations, use
 `@v5x/serial` in a browser that implements Web Serial.
 
@@ -73,6 +79,17 @@ v5x kv set key value
 Hardware commands accept `--port <path-or-id>` to target a specific serial
 device. Set `V5X_PORT` to use the same selector without repeating the flag.
 
+## Errors and exit codes
+
+Errors use a colored `error:` prefix. Pass `--verbose` or set `V5X_DEBUG=1` to
+include a stack trace. The CLI uses these exit codes for automation:
+
+- `1`: an unclassified failure
+- `2`: invalid arguments or usage
+- `3`: no matching or connected V5 device
+- `4`: a device protocol, transfer, or firmware failure
+- `5`: an I/O or download failure
+
 ## Development
 
 ```sh