mirror of
https://github.com/onyx-and-iris/obsws-cli.git
synced 2025-07-18 02:41:47 +00:00
move style section
add link to style section in ToC. add imgs.
This commit is contained in:
parent
4d37714aaf
commit
c3e55200db
60
README.md
60
README.md
@ -14,6 +14,7 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Configuration](#configuration)
|
||||
- [Style](#style)
|
||||
- [Commands](#root-typer)
|
||||
- [License](#license)
|
||||
|
||||
@ -68,6 +69,37 @@ OBS_PASSWORD=<websocket password>
|
||||
|
||||
Flags can be used to override environment variables.
|
||||
|
||||
## Style
|
||||
|
||||
Styling is opt-in, by default you will get a colourless output:
|
||||
|
||||

|
||||
|
||||
You may enable styling with the --style/-s flag:
|
||||
|
||||
```console
|
||||
obsws-cli --style="cyan" sceneitem list
|
||||
```
|
||||
|
||||
Available styles: _red, magenta, purple, blue, cyan, green, yellow, orange, white, grey, navy, black_
|
||||
|
||||

|
||||
|
||||
Optionally you may disable border colouring with the --no-border flag:
|
||||
|
||||

|
||||
|
||||
```console
|
||||
obsws-cli --style="cyan' --no-border sceneitem list
|
||||
```
|
||||
|
||||
Or with environment variables:
|
||||
|
||||
```env
|
||||
OBS_STYLE=cyan
|
||||
OBS_STYLE_NO_BORDER=true
|
||||
```
|
||||
|
||||
## Root Typer
|
||||
|
||||
- obs-version: Get the OBS Client and WebSocket versions.
|
||||
@ -628,34 +660,6 @@ obsws-cli projector open --monitor-index=1 "test_group"
|
||||
obsws-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
|
||||
```
|
||||
|
||||
## Style
|
||||
|
||||
By default styling is disabled but you may enable it with:
|
||||
|
||||
- --style/-s: Style used in output.
|
||||
- OBS_STYLE
|
||||
- --no-border/-b: Disable table border styling in output.
|
||||
- OBS_STYLE_NO_BORDER
|
||||
|
||||
Available styles:
|
||||
|
||||
- red
|
||||
- magenta
|
||||
- purple
|
||||
- blue
|
||||
- cyan
|
||||
- green
|
||||
- yellow
|
||||
- orange
|
||||
- white
|
||||
- grey
|
||||
- navy
|
||||
- black
|
||||
|
||||
```console
|
||||
obsws-cli --style=cyan --no-border scene list
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
`obsws-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
||||
|
BIN
img/coloured-border.png
Executable file
BIN
img/coloured-border.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 6.2 KiB |
BIN
img/coloured-no-border.png
Executable file
BIN
img/coloured-no-border.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 6.2 KiB |
BIN
img/colourless.png
Executable file
BIN
img/colourless.png
Executable file
Binary file not shown.
After Width: | Height: | Size: 5.4 KiB |
Loading…
x
Reference in New Issue
Block a user