@v5x/cli 0.0.21 → 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/LICENSE +21 -0
- package/README.md +20 -0
- package/dist/index.js +6586 -5216
- package/dist/index.js.map +56 -0
- package/package.json +36 -8
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Beanarchy Studios
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -13,6 +13,12 @@ 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, 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
|
+
For browser integrations, use
|
|
20
|
+
`@v5x/serial` in a browser that implements Web Serial.
|
|
21
|
+
|
|
16
22
|
```sh
|
|
17
23
|
v5x install pros
|
|
18
24
|
v5x install vexide
|
|
@@ -33,11 +39,22 @@ v5x upload --slot 2 --no-build --file ./bin/monolith.bin
|
|
|
33
39
|
# Build, upload, and immediately start the program.
|
|
34
40
|
v5x run --slot 2
|
|
35
41
|
|
|
42
|
+
# List, start, and stop programs already on the brain.
|
|
43
|
+
v5x programs
|
|
44
|
+
v5x start 2
|
|
45
|
+
v5x stop
|
|
46
|
+
|
|
36
47
|
# Create a project directly from the built-in templates.
|
|
37
48
|
v5x new robot --type pros
|
|
38
49
|
v5x new robot --type vexide
|
|
50
|
+
|
|
51
|
+
# Check local CLI prerequisites; exits 1 only when an error is reported.
|
|
52
|
+
v5x doctor
|
|
39
53
|
```
|
|
40
54
|
|
|
55
|
+
The PROS template is pinned by CLI release and verified with SHA-256 before it
|
|
56
|
+
is extracted.
|
|
57
|
+
|
|
41
58
|
`build`, `clean`, `upload`, and `run` accept an optional project directory.
|
|
42
59
|
Use `v5x <command> --help` for all options.
|
|
43
60
|
|
|
@@ -53,6 +70,9 @@ v5x kv get key
|
|
|
53
70
|
v5x kv set key value
|
|
54
71
|
```
|
|
55
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
|
+
|
|
56
76
|
## Development
|
|
57
77
|
|
|
58
78
|
```sh
|