mirror of
https://github.com/onyx-and-iris/obsws-cli.git
synced 2026-04-18 15:03:44 +00:00
swap out pydantic-settings for dotenv (speedup import time)
add short names for root options.
This commit is contained in:
14
README.md
14
README.md
@@ -42,7 +42,13 @@ The CLI should now be discoverable as `obsws-cli`
|
||||
|
||||
#### Flags
|
||||
|
||||
Pass `--host`, `--port` and `--password` as flags to the root command, for example:
|
||||
- --host/-H: Websocket host
|
||||
- --port/-P Websocket port
|
||||
- --password/-p: Websocket password
|
||||
- --timeout/-T: Websocket timeout
|
||||
- --version/-v: Print the obsws-cli version
|
||||
|
||||
Pass `--host`, `--port` and `--password` as flags on the root command, for example:
|
||||
|
||||
```console
|
||||
obsws-cli --host=localhost --port=4455 --password=<websocket password> --help
|
||||
@@ -64,12 +70,6 @@ Flags can be used to override environment variables.
|
||||
|
||||
## Root Typer
|
||||
|
||||
- --version/-v: Get the obsws-cli version:
|
||||
|
||||
```console
|
||||
obsws-cli --version
|
||||
```
|
||||
|
||||
- obs-version: Get the OBS Client and WebSocket versions.
|
||||
|
||||
```console
|
||||
|
||||
Reference in New Issue
Block a user