onyx_online/xair-cli
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/xair-cli.git synced 2026-02-26 08:19:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
onyx-and-iris 2026-02-07 03:54:48 +00:00
parent c19c7f278b
commit ba0b0eaee2
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -2,8 +2,15 @@
### Installation ### Installation
*xair-cli*
```console ```console
go install github.com/onyx-and-iris/xair-cli@latest go install github.com/onyx-and-iris/xair-cli/cmd/xair-cli@latest
```
*x32-cli*
```console
go install github.com/onyx-and-iris/xair-cli/cmd/x32-cli@latest
``` ```
### Configuration ### Configuration
@ -12,15 +19,13 @@ go install github.com/onyx-and-iris/xair-cli@latest
- --host/-H: Host of the mixer. - --host/-H: Host of the mixer.
- --port/-P: Port of the mixer. - --port/-P: Port of the mixer.
- --kind/-k: The kind of mixer. May be one of (*xair*, *x32*).
- Use this flag to connect to an x32 mixer.
- --timeout/-T: Timeout for OSC operations. - --timeout/-T: Timeout for OSC operations.
- --loglevel/-L: The application's logging verbosity. - --loglevel/-L: The application's logging verbosity.
Pass `--host` and any other configuration as flags on the root commmand: Pass `--host` and any other configuration as flags on the root commmand:
```console ```console
xair-cli --host mixer.local --kind xair --timeout 50ms --help xair-cli --host mixer.local --timeout 50ms --help
``` ```
#### Environment Variables #### Environment Variables
@ -34,7 +39,6 @@ Example .envrc:
export XAIR_CLI_HOST=mixer.local export XAIR_CLI_HOST=mixer.local
export XAIR_CLI_PORT=10024 export XAIR_CLI_PORT=10024
export XAIR_CLI_KIND=xair
export XAIR_CLI_TIMEOUT=100ms export XAIR_CLI_TIMEOUT=100ms
export XAIR_CLI_LOGLEVEL=warn export XAIR_CLI_LOGLEVEL=warn
``` ```
@ -50,7 +54,6 @@ Flags:
-h, --help Show context-sensitive help. -h, --help Show context-sensitive help.
-H, --host="mixer.local" The host of the X-Air device ($XAIR_CLI_HOST). -H, --host="mixer.local" The host of the X-Air device ($XAIR_CLI_HOST).
-P, --port=10024 The port of the X-Air device ($XAIR_CLI_PORT). -P, --port=10024 The port of the X-Air device ($XAIR_CLI_PORT).
-K, --kind="xair" The kind of the X-Air device ($XAIR_CLI_KIND).
-T, --timeout=100ms Timeout for OSC operations ($XAIR_CLI_TIMEOUT). -T, --timeout=100ms Timeout for OSC operations ($XAIR_CLI_TIMEOUT).
-L, --loglevel="warn" Log level for the CLI ($XAIR_CLI_LOGLEVEL). -L, --loglevel="warn" Log level for the CLI ($XAIR_CLI_LOGLEVEL).
-v, --version Print xair-cli version information and quit -v, --version Print xair-cli version information and quit