onyx_online/gobs-cli
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/gobs-cli.git synced 2026-04-18 07:03:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

add short names for root options

Browse Source 
fix flag example in readme
This commit is contained in:
onyx-and-iris
2025-06-03 12:33:37 +01:00
parent 89a5add7ad
commit 4446784709
3 changed files with 14 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -14,10 +14,16 @@ go install github.com/onyx-and-iris/gobs-cli@latest
#### 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 gobs-cli version
Pass `--host`, `--port` and `--password` as flags on the root command, for example:
```console
gobs-cli --host=localhost --port=4455 --password=<websocket password> --help
gobs-cli --host localhost --port 4455 --password 'websocket password' --help
```
#### Environment Variables
@@ -37,14 +43,6 @@ OBS_TIMEOUT=5
## Commands
### VersionFlag
- --version/-v: Print gobs-cli version information and quit
```console
gobs-cli --version
```
### ObsVersionCmd
- Print OBS client and websocket version.