mirror of
https://github.com/onyx-and-iris/xair-cli.git
synced 2026-02-26 08:19:11 +00:00
add Configuration section to README
This commit is contained in:
parent
d87bc2678c
commit
e092ed3c4e
24
README.md
24
README.md
@ -6,6 +6,30 @@
|
|||||||
go install github.com/onyx-and-iris/xair-cli@latest
|
go install github.com/onyx-and-iris/xair-cli@latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Configuration
|
||||||
|
|
||||||
|
#### Flags
|
||||||
|
|
||||||
|
Although there exist flags/environment variables for `--host`, `--port` and `--kind` you should only need `--host` for xair mixers and `--host`, `--kind` for the x32.
|
||||||
|
|
||||||
|
- --host/-H: You mixers IP
|
||||||
|
- --kind/-k: The kind of mixer, use this to connect to an x32. It does two things:
|
||||||
|
- Adjusts the port to 10023
|
||||||
|
- Updates some of the OSC addresses.
|
||||||
|
|
||||||
|
#### Environment Variables
|
||||||
|
|
||||||
|
Example .envrc:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
XAIR_CLI_HOST=mixer.local
|
||||||
|
XAIR_CLI_PORT=10024
|
||||||
|
XAIR_CLI_KIND=xr18
|
||||||
|
XAIR_CLI_RAW_TIMEOUT=50ms
|
||||||
|
```
|
||||||
|
|
||||||
### Use
|
### Use
|
||||||
|
|
||||||
```console
|
```console
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user