mirror of
https://github.com/onyx-and-iris/gobs-cli.git
synced 2026-04-18 15:13:39 +00:00
Compare commits
9 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| c6406888a9 | |||
| f65af8298d | |||
| 1dfb6f87ac | |||
| 866aedde7c | |||
| 9eb6c8a282 | |||
| eb30cae5b7 | |||
| e6c03a2c92 | |||
| f6b82383f9 | |||
| 55f3b0c981 |
12
CHANGELOG.md
12
CHANGELOG.md
@@ -5,13 +5,23 @@ All notable changes to this project will be documented in this file.
|
|||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
# [0.13.2] - 2025-06-26
|
# [0.14.1] - 2025-07-14
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- text command group, see [TextCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#textcmd)
|
||||||
|
|
||||||
|
# [0.13.3] - 2025-06-27
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
- usage is now printed on errors.
|
- usage is now printed on errors.
|
||||||
- help is printed in compact mode. This should make it easier to page through help on the root command.
|
- help is printed in compact mode. This should make it easier to page through help on the root command.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Item ID alignment in sceneitem list table.
|
||||||
|
|
||||||
# [0.13.0] - 2025-06-23
|
# [0.13.0] - 2025-06-23
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|||||||
84
README.md
84
README.md
@@ -4,6 +4,16 @@ 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)
|
||||||
|
- [Style](#style)
|
||||||
|
- [Commands](#commands)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```console
|
```console
|
||||||
@@ -40,6 +50,36 @@ OBS_PASSWORD=<websocket password>
|
|||||||
OBS_TIMEOUT=5
|
OBS_TIMEOUT=5
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Style
|
||||||
|
|
||||||
|
Styling is opt-in, by default you will get a colourless output:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
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_
|
||||||
|
|
||||||
|

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

|
||||||
|
|
||||||
|
```console
|
||||||
|
gobs-cli --style="red" --no-border sceneitem list
|
||||||
|
```
|
||||||
|
|
||||||
|
Or with environment variables:
|
||||||
|
|
||||||
|
```env
|
||||||
|
GOBS_STYLE=red
|
||||||
|
GOBS_STYLE_NO_BORDER=true
|
||||||
|
```
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
@@ -262,6 +302,22 @@ gobs-cli input unmute "Mic/Aux"
|
|||||||
gobs-cli input toggle "Mic/Aux"
|
gobs-cli input toggle "Mic/Aux"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### TextCmd
|
||||||
|
|
||||||
|
- current: Display current text for a text input.
|
||||||
|
- args: InputName
|
||||||
|
|
||||||
|
```console
|
||||||
|
gobs-cli text current "My Text Input"
|
||||||
|
```
|
||||||
|
|
||||||
|
- update: Update the text of a text input.
|
||||||
|
- args: InputName NewText
|
||||||
|
|
||||||
|
```console
|
||||||
|
gobs-cli text update "My Text Input" "hi OBS!"
|
||||||
|
```
|
||||||
|
|
||||||
### RecordCmd
|
### RecordCmd
|
||||||
|
|
||||||
- start: Start recording.
|
- start: Start recording.
|
||||||
@@ -621,33 +677,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
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
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
BIN
img/colourless.png
Executable file
Binary file not shown.
|
After Width: | Height: | Size: 4.6 KiB |
1
main.go
1
main.go
@@ -59,6 +59,7 @@ type CLI struct {
|
|||||||
Sceneitem SceneItemCmd `help:"Manage scene items." cmd:"" aliases:"si" group:"Scene Item"`
|
Sceneitem SceneItemCmd `help:"Manage scene items." cmd:"" aliases:"si" group:"Scene Item"`
|
||||||
Group GroupCmd `help:"Manage groups." cmd:"" aliases:"g" group:"Group"`
|
Group GroupCmd `help:"Manage groups." cmd:"" aliases:"g" group:"Group"`
|
||||||
Input InputCmd `help:"Manage inputs." cmd:"" aliases:"i" group:"Input"`
|
Input InputCmd `help:"Manage inputs." cmd:"" aliases:"i" group:"Input"`
|
||||||
|
Text TextCmd `help:"Manage text inputs." cmd:"" aliases:"t" group:"Text Input"`
|
||||||
Record RecordCmd `help:"Manage recording." cmd:"" aliases:"rec" group:"Recording"`
|
Record RecordCmd `help:"Manage recording." cmd:"" aliases:"rec" group:"Recording"`
|
||||||
Stream StreamCmd `help:"Manage streaming." cmd:"" aliases:"st" group:"Streaming"`
|
Stream StreamCmd `help:"Manage streaming." cmd:"" aliases:"st" group:"Streaming"`
|
||||||
Scenecollection SceneCollectionCmd `help:"Manage scene collections." cmd:"" aliases:"scn" group:"Scene Collection"`
|
Scenecollection SceneCollectionCmd `help:"Manage scene collections." cmd:"" aliases:"scn" group:"Scene Collection"`
|
||||||
|
|||||||
@@ -59,7 +59,7 @@ func (cmd *SceneItemListCmd) Run(ctx *context) error {
|
|||||||
style := lipgloss.NewStyle().Padding(0, 3)
|
style := lipgloss.NewStyle().Padding(0, 3)
|
||||||
switch col {
|
switch col {
|
||||||
case 0:
|
case 0:
|
||||||
style = style.Align(lipgloss.Left)
|
style = style.Align(lipgloss.Center)
|
||||||
case 1:
|
case 1:
|
||||||
style = style.Align(lipgloss.Left)
|
style = style.Align(lipgloss.Left)
|
||||||
case 2:
|
case 2:
|
||||||
|
|||||||
85
text.go
Normal file
85
text.go
Normal file
@@ -0,0 +1,85 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"github.com/andreykaipov/goobs/api/requests/inputs"
|
||||||
|
)
|
||||||
|
|
||||||
|
// TextCmd provides commands for managing text inputs in OBS.
|
||||||
|
type TextCmd struct {
|
||||||
|
Current TextCurrentCmd `cmd:"current" help:"Display current text for a text input." aliases:"c"`
|
||||||
|
Update TextUpdateCmd `cmd:"update" help:"Update the text of a text input." aliases:"u"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// TextCurrentCmd provides a command to display the current text of a text input.
|
||||||
|
type TextCurrentCmd struct {
|
||||||
|
InputName string `arg:"" help:"Name of the text source."`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run executes the command to display the current text of a text input.
|
||||||
|
func (cmd *TextCurrentCmd) Run(ctx *context) error {
|
||||||
|
resp, err := ctx.Client.Inputs.GetInputSettings(
|
||||||
|
inputs.NewGetInputSettingsParams().WithInputName(cmd.InputName),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to get input settings: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check if the input is a text input
|
||||||
|
kind := resp.InputKind
|
||||||
|
if !strings.HasPrefix(kind, "text_") {
|
||||||
|
return fmt.Errorf("input %s is of %s", cmd.InputName, kind)
|
||||||
|
}
|
||||||
|
|
||||||
|
currentText, ok := resp.InputSettings["text"]
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("input %s does not have a 'text' setting", cmd.InputName)
|
||||||
|
}
|
||||||
|
if currentText == "" {
|
||||||
|
currentText = "(empty)"
|
||||||
|
}
|
||||||
|
fmt.Fprintf(
|
||||||
|
ctx.Out,
|
||||||
|
"Current text for source %s: %s\n",
|
||||||
|
ctx.Style.Highlight(cmd.InputName),
|
||||||
|
currentText,
|
||||||
|
)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// TextUpdateCmd provides a command to update the text of a text input.
|
||||||
|
type TextUpdateCmd struct {
|
||||||
|
InputName string `arg:"" help:"Name of the text source."`
|
||||||
|
NewText string `arg:"" help:"New text to set for the source." default:""`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run executes the command to update the text of a text input.
|
||||||
|
func (cmd *TextUpdateCmd) Run(ctx *context) error {
|
||||||
|
resp, err := ctx.Client.Inputs.GetInputSettings(
|
||||||
|
inputs.NewGetInputSettingsParams().WithInputName(cmd.InputName),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to get input settings: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check if the input is a text input
|
||||||
|
kind := resp.InputKind
|
||||||
|
if !strings.HasPrefix(kind, "text_") {
|
||||||
|
return fmt.Errorf("input %s is of %s", cmd.InputName, kind)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err := ctx.Client.Inputs.SetInputSettings(&inputs.SetInputSettingsParams{
|
||||||
|
InputName: &cmd.InputName,
|
||||||
|
InputSettings: map[string]any{"text": &cmd.NewText},
|
||||||
|
}); err != nil {
|
||||||
|
return fmt.Errorf("failed to update text for source %s: %w", cmd.InputName, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if cmd.NewText == "" {
|
||||||
|
cmd.NewText = "(empty)"
|
||||||
|
}
|
||||||
|
fmt.Fprintf(ctx.Out, "Updated text for source %s to: %s\n", ctx.Style.Highlight(cmd.InputName), cmd.NewText)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user