add ToC to README

move style section.

add imgs
This commit is contained in:
onyx-and-iris 2025-06-27 13:48:17 +01:00
parent 55f3b0c981
commit f6b82383f9
4 changed files with 41 additions and 26 deletions

View File

@ -4,6 +4,15 @@ A command line interface for OBS Websocket v5
For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md) For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
-----
## Table of Contents
- [Installation](#installation)
- [Configuration](#configuration)
- [Commands](#commands)
- [License](#license)
## Installation ## Installation
```console ```console
@ -40,6 +49,36 @@ OBS_PASSWORD=<websocket password>
OBS_TIMEOUT=5 OBS_TIMEOUT=5
``` ```
## Style
Styling is opt-in, by default you will get a colourless output:
![colourless](./img/colourless.png)
You may enable styling with the --style/-s flag:
```console
gobs-cli --style="red" sceneitem list
```
Available styles: _red, magenta, purple, blue, cyan, green, yellow, orange, white, grey, navy, black_
![coloured](./img/coloured-border.png)
Optionally you may disable border colouring with the --no-border flag:
![coloured-no-border](./img/coloured-no-border.png)
```console
gobs-cli --style="red" --no-border sceneitem list
```
Or with environment variables:
```env
GOBS_STYLE=cyan
GOBS_STYLE_NO_BORDER=true
```
## Commands ## Commands
@ -621,33 +660,9 @@ gobs-cli projector open --monitor-index=1 "test_group"
gobs-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png" gobs-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
``` ```
## Style ## License
By default styling is disabled but you may enable and configure it in the following ways: `gobs-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
- --style/-s: Style used in output.
- GOBS_STYLE
- --no-border/-b: Disable table border styling in output.
- GOBS_STYLE_NO_BORDER
Available styles:
- red
- magenta
- purple
- blue
- cyan
- green
- yellow
- orange
- white
- grey
- navy
- black
```console
gobs-cli --style=cyan --no-border scene list
```
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir [userconfigdir]: https://pkg.go.dev/os#UserConfigDir

BIN
img/coloured-border.png Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

BIN
img/coloured-no-border.png Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

BIN
img/colourless.png Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.6 KiB