@v5x/cli 0.0.22 → 0.0.24
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -3
- package/dist/index.js +5814 -5236
- package/dist/index.js.map +36 -29
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -6,6 +6,12 @@ See the [complete CLI documentation](https://docs.v5x.dev/cli/overview) for work
|
|
|
6
6
|
|
|
7
7
|
## Install
|
|
8
8
|
|
|
9
|
+
```sh
|
|
10
|
+
curl -fsSL https://v5x.dev/install.sh | sh
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Alternatively, install the package with Bun 1.3.14 or newer:
|
|
14
|
+
|
|
9
15
|
```sh
|
|
10
16
|
bun add --global @v5x/cli
|
|
11
17
|
```
|
|
@@ -13,9 +19,9 @@ bun add --global @v5x/cli
|
|
|
13
19
|
The CLI supports PROS, vexide, and VEXcode C++ projects. The corresponding
|
|
14
20
|
compiler toolchain must be installed before building a project.
|
|
15
21
|
|
|
16
|
-
The current CLI release supports Linux and macOS
|
|
17
|
-
|
|
18
|
-
|
|
22
|
+
The current CLI release supports Linux and macOS, matching the package
|
|
23
|
+
metadata's `os` field. Windows is not published yet because the CLI needs a
|
|
24
|
+
compatible serial backend there.
|
|
19
25
|
For browser integrations, use
|
|
20
26
|
`@v5x/serial` in a browser that implements Web Serial.
|
|
21
27
|
|
|
@@ -47,6 +53,9 @@ v5x stop
|
|
|
47
53
|
# Create a project directly from the built-in templates.
|
|
48
54
|
v5x new robot --type pros
|
|
49
55
|
v5x new robot --type vexide
|
|
56
|
+
|
|
57
|
+
# Check local CLI prerequisites; exits 1 only when an error is reported.
|
|
58
|
+
v5x doctor
|
|
50
59
|
```
|
|
51
60
|
|
|
52
61
|
The PROS template is pinned by CLI release and verified with SHA-256 before it
|
|
@@ -67,6 +76,20 @@ v5x kv get key
|
|
|
67
76
|
v5x kv set key value
|
|
68
77
|
```
|
|
69
78
|
|
|
79
|
+
Hardware commands accept `--port <path-or-id>` to target a specific serial
|
|
80
|
+
device. Set `V5X_PORT` to use the same selector without repeating the flag.
|
|
81
|
+
|
|
82
|
+
## Errors and exit codes
|
|
83
|
+
|
|
84
|
+
Errors use a colored `error:` prefix. Pass `--verbose` or set `V5X_DEBUG=1` to
|
|
85
|
+
include a stack trace. The CLI uses these exit codes for automation:
|
|
86
|
+
|
|
87
|
+
- `1`: an unclassified failure
|
|
88
|
+
- `2`: invalid arguments or usage
|
|
89
|
+
- `3`: no matching or connected V5 device
|
|
90
|
+
- `4`: a device protocol, transfer, or firmware failure
|
|
91
|
+
- `5`: an I/O or download failure
|
|
92
|
+
|
|
70
93
|
## Development
|
|
71
94
|
|
|
72
95
|
```sh
|