4 Commits

Author SHA1 Message Date
b8b637b4b7 upd snapshot subcommand help output 2026-02-06 17:47:21 +00:00
52d51a7094 reword 2026-02-06 17:45:30 +00:00
09a4e9fbfc upd Configuration in README 2026-02-06 17:45:12 +00:00
04f7319776 add loglevel to Configuration section 2026-02-06 17:37:57 +00:00
2 changed files with 14 additions and 4 deletions

View File

@@ -14,9 +14,18 @@ go install github.com/onyx-and-iris/xair-cli@latest
- --port/-P: Port of the mixer. - --port/-P: Port of the mixer.
- --kind/-k: The kind of mixer. May be one of (*xair*, *x32*). - --kind/-k: The kind of mixer. May be one of (*xair*, *x32*).
- Use this flag to connect to an x32 mixer. - Use this flag to connect to an x32 mixer.
- --loglevel/-L: The application's logging verbosity.
Pass `--host` and any other configuration as flags on the root commmand:
```console
xair-cli --host mixer.local --kind xair --timeout 50ms --help
```
#### Environment Variables #### Environment Variables
Or you may load them from your environment:
Example .envrc: Example .envrc:
```bash ```bash
@@ -26,6 +35,7 @@ XAIR_CLI_HOST=mixer.local
XAIR_CLI_PORT=10024 XAIR_CLI_PORT=10024
XAIR_CLI_KIND=xair XAIR_CLI_KIND=xair
XAIR_CLI_TIMEOUT=100ms XAIR_CLI_TIMEOUT=100ms
XAIR_CLI_LOGLEVEL=warn
``` ```
### Use ### Use
@@ -114,8 +124,8 @@ Headamp
Snapshot Snapshot
snapshot list List all snapshots. snapshot list List all snapshots.
snapshot <index> name Get or set the name of a snapshot. snapshot <index> name Get or set the name of a snapshot.
snapshot <index> save Save the current mixer state. snapshot <index> save Save the current mixer state to a snapshot.
snapshot <index> load Load a mixer state. snapshot <index> load Load a mixer state from a snapshot.
snapshot <index> delete Delete a snapshot. snapshot <index> delete Delete a snapshot.
Run "xair-cli <command> --help" for more information on a command. Run "xair-cli <command> --help" for more information on a command.

View File

@@ -7,8 +7,8 @@ type SnapshotCmdGroup struct {
Index struct { Index struct {
Index int `arg:"" help:"The index of the snapshot."` Index int `arg:"" help:"The index of the snapshot."`
Name NameCmd `help:"Get or set the name of a snapshot." cmd:"name"` Name NameCmd `help:"Get or set the name of a snapshot." cmd:"name"`
Save SaveCmd `help:"Save the current mixer state." cmd:"save"` Save SaveCmd `help:"Save the current mixer state to a snapshot." cmd:"save"`
Load LoadCmd `help:"Load a mixer state." cmd:"load"` Load LoadCmd `help:"Load a mixer state from a snapshot." cmd:"load"`
Delete DeleteCmd `help:"Delete a snapshot." cmd:"delete"` Delete DeleteCmd `help:"Delete a snapshot." cmd:"delete"`
} `help:"The index of the snapshot." arg:""` } `help:"The index of the snapshot." arg:""`
} }