@v5x/cli 0.0.22 → 0.0.23

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 CHANGED
@@ -13,9 +13,9 @@ bun add --global @v5x/cli
13
13
  The CLI supports PROS, vexide, and VEXcode C++ projects. The corresponding
14
14
  compiler toolchain must be installed before building a project.
15
15
 
16
- The current CLI release supports Linux and macOS. Bun 1.3.14 or newer is
17
- required. Windows requires a different serial backend because `bun-serialport`
18
- supports POSIX serial APIs only.
16
+ The current CLI release supports Linux and macOS, matching the package
17
+ metadata's `os` field. Bun 1.3.14 or newer is required. Windows is not
18
+ published yet because the CLI needs a compatible serial backend there.
19
19
  For browser integrations, use
20
20
  `@v5x/serial` in a browser that implements Web Serial.
21
21
 
@@ -47,6 +47,9 @@ v5x stop
47
47
  # Create a project directly from the built-in templates.
48
48
  v5x new robot --type pros
49
49
  v5x new robot --type vexide
50
+
51
+ # Check local CLI prerequisites; exits 1 only when an error is reported.
52
+ v5x doctor
50
53
  ```
51
54
 
52
55
  The PROS template is pinned by CLI release and verified with SHA-256 before it
@@ -67,6 +70,9 @@ v5x kv get key
67
70
  v5x kv set key value
68
71
  ```
69
72
 
73
+ Hardware commands accept `--port <path-or-id>` to target a specific serial
74
+ device. Set `V5X_PORT` to use the same selector without repeating the flag.
75
+
70
76
  ## Development
71
77
 
72
78
  ```sh