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

add Configuration section to README

Browse Source
This commit is contained in:
onyx-and-iris 2026-02-05 15:42:39 +00:00
parent d87bc2678c
commit e092ed3c4e
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -6,6 +6,30 @@
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
```console