mirror of
https://github.com/jwetzell/aas-js.git
synced 2026-08-14 08:53:39 +00:00
add build and run info to readme
This commit is contained in:
@@ -10,4 +10,25 @@
|
||||
- soccer
|
||||
- hockey
|
||||
- track
|
||||
- whirley
|
||||
- whirley
|
||||
|
||||
## Build
|
||||
- clone/download repo
|
||||
- in repo run `npm install && npm run build:cli`
|
||||
- find binary in `packages/cli/dist/`
|
||||
|
||||
## Usage
|
||||
```
|
||||
Usage: aas-cli [options]
|
||||
|
||||
Simple protocol router /s
|
||||
|
||||
Options:
|
||||
-V, --version output the version number
|
||||
-d, --device <serial port path> serialport path
|
||||
-o, --output <output file> file to write console info to
|
||||
-f, --format <output format> (choices: "json", "xml", "yaml", default: "json")
|
||||
--websocket <port> enable websocket server for updates
|
||||
-h, --help display help for command
|
||||
```
|
||||
If a device isn't supplied with the `-d/--device` flag then you will be prompted to select one.
|
||||
Reference in New Issue
Block a user