mirror of
https://github.com/onyx-and-iris/gobs-cli.git
synced 2026-04-18 07:03:37 +00:00
Compare commits
24 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 8a5ce67ba0 | |||
| 474693e0f7 | |||
| a960c9ffa5 | |||
| 8ce8727a0a | |||
|
|
fba7c4ce20 | ||
|
|
c5e7bb4e1a | ||
|
|
e087fdefe3 | ||
|
|
bd4a6cad4b | ||
|
|
72fc7d4092 | ||
|
|
cb735cd666 | ||
|
|
db70f8766d | ||
| c6406888a9 | |||
| f65af8298d | |||
| 1dfb6f87ac | |||
| 866aedde7c | |||
| 9eb6c8a282 | |||
| eb30cae5b7 | |||
| e6c03a2c92 | |||
| f6b82383f9 | |||
| 55f3b0c981 | |||
| 7da80a1ad2 | |||
| ea4ca2aeb9 | |||
| d2f0a64180 | |||
| f01fd0ca84 |
24
CHANGELOG.md
24
CHANGELOG.md
@@ -5,11 +5,35 @@ 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.15.0] - 2026-01-26
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- new subcommands added to input, see [InputCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#inputcmd)
|
||||||
|
|
||||||
|
# [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
|
||||||
|
|
||||||
|
- 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.
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Item ID alignment in sceneitem list table.
|
||||||
|
|
||||||
# [0.13.0] - 2025-06-23
|
# [0.13.0] - 2025-06-23
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- record split and record chapter commands, see [RecordCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#recordcmd)
|
- record split and record chapter commands, see [RecordCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#recordcmd)
|
||||||
|
- As of OBS 30.2.0, the only file format supporting *record chapter* is Hybrid MP4.
|
||||||
|
|
||||||
# [0.12.1] - 2025-06-21
|
# [0.12.1] - 2025-06-21
|
||||||
|
|
||||||
|
|||||||
132
README.md
132
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
|
||||||
|
|
||||||
@@ -224,6 +264,20 @@ gobs-cli group status START "test_group"
|
|||||||
|
|
||||||
### InputCmd
|
### InputCmd
|
||||||
|
|
||||||
|
- create: Create input.
|
||||||
|
- args: Name Kind
|
||||||
|
|
||||||
|
```console
|
||||||
|
gobs-cli input create 'stream mix' 'wasapi_input_capture'
|
||||||
|
```
|
||||||
|
|
||||||
|
- remove: Remove input.
|
||||||
|
- args: Name
|
||||||
|
|
||||||
|
```console
|
||||||
|
gobs-cli input remove 'stream mix'
|
||||||
|
```
|
||||||
|
|
||||||
- list: List all inputs.
|
- list: List all inputs.
|
||||||
- flags:
|
- flags:
|
||||||
|
|
||||||
@@ -241,6 +295,12 @@ gobs-cli input list
|
|||||||
gobs-cli input list --input --colour
|
gobs-cli input list --input --colour
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- list-kinds: List input kinds.
|
||||||
|
|
||||||
|
```console
|
||||||
|
gobs-cli input list-kinds
|
||||||
|
```
|
||||||
|
|
||||||
- mute: Mute input.
|
- mute: Mute input.
|
||||||
- args: InputName
|
- args: InputName
|
||||||
|
|
||||||
@@ -262,6 +322,50 @@ gobs-cli input unmute "Mic/Aux"
|
|||||||
gobs-cli input toggle "Mic/Aux"
|
gobs-cli input toggle "Mic/Aux"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
- volume: Set input volume.
|
||||||
|
- args: InputName Volume
|
||||||
|
|
||||||
|
```console
|
||||||
|
gobs-cli input volume -- 'Mic/Aux' -30.6
|
||||||
|
```
|
||||||
|
|
||||||
|
- show: Show input details.
|
||||||
|
- args: Name
|
||||||
|
- flags:
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- --verbose: List all available input devices.
|
||||||
|
|
||||||
|
- update: Update input settings.
|
||||||
|
- args: InputName DeviceName
|
||||||
|
|
||||||
|
```console
|
||||||
|
gobs-cli input update 'Mic/Aux' 'Voicemeeter Out B1 (VB-Audio Voicemeeter VAIO)'
|
||||||
|
```
|
||||||
|
|
||||||
|
- kind-defaults: Get default settings for an input kind.
|
||||||
|
- args: Kind
|
||||||
|
|
||||||
|
```console
|
||||||
|
gobs-cli input kind-defaults 'wasapi_input_capture'
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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 +725,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 |
373
input.go
373
input.go
@@ -3,6 +3,7 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"maps"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
@@ -13,10 +14,63 @@ import (
|
|||||||
|
|
||||||
// InputCmd provides commands to manage inputs in OBS Studio.
|
// InputCmd provides commands to manage inputs in OBS Studio.
|
||||||
type InputCmd struct {
|
type InputCmd struct {
|
||||||
List InputListCmd `cmd:"" help:"List all inputs." aliases:"ls"`
|
Create InputCreateCmd `cmd:"" help:"Create input." aliases:"c"`
|
||||||
Mute InputMuteCmd `cmd:"" help:"Mute input." aliases:"m"`
|
Remove InputRemoveCmd `cmd:"" help:"Remove input." aliases:"d"`
|
||||||
Unmute InputUnmuteCmd `cmd:"" help:"Unmute input." aliases:"um"`
|
List InputListCmd `cmd:"" help:"List all inputs." aliases:"ls"`
|
||||||
Toggle InputToggleCmd `cmd:"" help:"Toggle input." aliases:"tg"`
|
ListKinds InputListKindsCmd `cmd:"" help:"List input kinds." aliases:"k"`
|
||||||
|
Mute InputMuteCmd `cmd:"" help:"Mute input." aliases:"m"`
|
||||||
|
Unmute InputUnmuteCmd `cmd:"" help:"Unmute input." aliases:"um"`
|
||||||
|
Toggle InputToggleCmd `cmd:"" help:"Toggle input." aliases:"tg"`
|
||||||
|
Volume InputVolumeCmd `cmd:"" help:"Set input volume." aliases:"v"`
|
||||||
|
Show InputShowCmd `cmd:"" help:"Show input details." aliases:"s"`
|
||||||
|
Update InputUpdateCmd `cmd:"" help:"Update input settings." aliases:"up"`
|
||||||
|
KindDefaults InputKindDefaultsCmd `cmd:"" help:"Get default settings for an input kind." aliases:"df"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// InputCreateCmd provides a command to create an input.
|
||||||
|
type InputCreateCmd struct {
|
||||||
|
Name string `arg:"" help:"Name for the input." required:""`
|
||||||
|
Kind string `arg:"" help:"Input kind (e.g., coreaudio_input_capture, macos-avcapture)." required:""`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run executes the command to create an input.
|
||||||
|
func (cmd *InputCreateCmd) Run(ctx *context) error {
|
||||||
|
currentScene, err := ctx.Client.Scenes.GetCurrentProgramScene()
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = ctx.Client.Inputs.CreateInput(
|
||||||
|
inputs.NewCreateInputParams().
|
||||||
|
WithInputKind(cmd.Kind).
|
||||||
|
WithInputName(cmd.Name).
|
||||||
|
WithSceneName(currentScene.CurrentProgramSceneName),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Fprintf(ctx.Out, "Created input: %s (%s) in scene %s\n",
|
||||||
|
ctx.Style.Highlight(cmd.Name), cmd.Kind, ctx.Style.Highlight(currentScene.CurrentProgramSceneName))
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// InputRemoveCmd provides a command to remove an input.
|
||||||
|
type InputRemoveCmd struct {
|
||||||
|
Name string `arg:"" help:"Name of the input to remove." required:""`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run executes the command to remove an input.
|
||||||
|
func (cmd *InputRemoveCmd) Run(ctx *context) error {
|
||||||
|
_, err := ctx.Client.Inputs.RemoveInput(
|
||||||
|
inputs.NewRemoveInputParams().WithInputName(cmd.Name),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to delete input: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Fprintf(ctx.Out, "Deleted %s\n", ctx.Style.Highlight(cmd.Name))
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// InputListCmd provides a command to list all inputs.
|
// InputListCmd provides a command to list all inputs.
|
||||||
@@ -122,6 +176,47 @@ func (cmd *InputListCmd) Run(ctx *context) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// InputListKindsCmd provides a command to list all input kinds.
|
||||||
|
type InputListKindsCmd struct{}
|
||||||
|
|
||||||
|
// Run executes the command to list all input kinds.
|
||||||
|
func (cmd *InputListKindsCmd) Run(ctx *context) error {
|
||||||
|
resp, err := ctx.Client.Inputs.GetInputKindList(
|
||||||
|
inputs.NewGetInputKindListParams().WithUnversioned(false),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to get input kinds: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
t := table.New().Border(lipgloss.RoundedBorder()).
|
||||||
|
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
|
||||||
|
t.Headers("Kind")
|
||||||
|
t.StyleFunc(func(row, col int) lipgloss.Style {
|
||||||
|
style := lipgloss.NewStyle().Padding(0, 3)
|
||||||
|
switch col {
|
||||||
|
case 0:
|
||||||
|
style = style.Align(lipgloss.Left)
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case row == table.HeaderRow:
|
||||||
|
style = style.Bold(true).Align(lipgloss.Center)
|
||||||
|
case row%2 == 0:
|
||||||
|
style = style.Foreground(ctx.Style.evenRows)
|
||||||
|
default:
|
||||||
|
style = style.Foreground(ctx.Style.oddRows)
|
||||||
|
}
|
||||||
|
return style
|
||||||
|
})
|
||||||
|
|
||||||
|
for _, kind := range resp.InputKinds {
|
||||||
|
t.Row(kind)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Fprintln(ctx.Out, t.Render())
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// InputMuteCmd provides a command to mute an input.
|
// InputMuteCmd provides a command to mute an input.
|
||||||
type InputMuteCmd struct {
|
type InputMuteCmd struct {
|
||||||
InputName string `arg:"" help:"Name of the input to mute."`
|
InputName string `arg:"" help:"Name of the input to mute."`
|
||||||
@@ -188,3 +283,273 @@ func (cmd *InputToggleCmd) Run(ctx *context) error {
|
|||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// InputVolumeCmd provides a command to set the volume of an input.
|
||||||
|
type InputVolumeCmd struct {
|
||||||
|
InputName string `arg:"" help:"Name of the input to set volume for." required:""`
|
||||||
|
Volume float64 `arg:"" help:"Volume level (-90.0 to 0.0)." required:""`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run executes the command to set the volume of an input.
|
||||||
|
// accepts values between -90.0 and 0.0 representing decibels (dB).
|
||||||
|
func (cmd *InputVolumeCmd) Run(ctx *context) error {
|
||||||
|
if cmd.Volume < -90.0 || cmd.Volume > 0.0 {
|
||||||
|
return fmt.Errorf("volume must be between -90.0 and 0.0 dB")
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err := ctx.Client.Inputs.SetInputVolume(
|
||||||
|
inputs.NewSetInputVolumeParams().
|
||||||
|
WithInputName(cmd.InputName).
|
||||||
|
WithInputVolumeDb(cmd.Volume),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to set input volume: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Fprintf(ctx.Out, "Set volume of input %s to %.1f dB\n",
|
||||||
|
ctx.Style.Highlight(cmd.InputName), cmd.Volume)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// InputShowCmd provides a command to show input details.
|
||||||
|
type InputShowCmd struct {
|
||||||
|
Name string `arg:"" help:"Name of the input to show." required:""`
|
||||||
|
Verbose bool ` help:"List all available input devices." flag:""`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run executes the command to show input details.
|
||||||
|
func (cmd *InputShowCmd) Run(ctx *context) error {
|
||||||
|
lresp, err := ctx.Client.Inputs.GetInputList(inputs.NewGetInputListParams())
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to get input list: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var inputKind string
|
||||||
|
var found bool
|
||||||
|
for _, input := range lresp.Inputs {
|
||||||
|
if input.InputName == cmd.Name {
|
||||||
|
inputKind = input.InputKind
|
||||||
|
found = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if !found {
|
||||||
|
return fmt.Errorf("input '%s' not found", cmd.Name)
|
||||||
|
}
|
||||||
|
|
||||||
|
prop, name := device(ctx, cmd.Name)
|
||||||
|
if prop == "" {
|
||||||
|
return fmt.Errorf("no device property found for input '%s'", cmd.Name)
|
||||||
|
}
|
||||||
|
|
||||||
|
t := table.New().Border(lipgloss.RoundedBorder()).
|
||||||
|
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
|
||||||
|
t.Headers("Input Name", "Kind", "Device")
|
||||||
|
t.StyleFunc(func(row, col int) lipgloss.Style {
|
||||||
|
style := lipgloss.NewStyle().Padding(0, 3)
|
||||||
|
switch col {
|
||||||
|
case 0:
|
||||||
|
style = style.Align(lipgloss.Left)
|
||||||
|
case 1:
|
||||||
|
style = style.Align(lipgloss.Left)
|
||||||
|
case 2:
|
||||||
|
style = style.Align(lipgloss.Center)
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case row == table.HeaderRow:
|
||||||
|
style = style.Bold(true).Align(lipgloss.Center)
|
||||||
|
case row%2 == 0:
|
||||||
|
style = style.Foreground(ctx.Style.evenRows)
|
||||||
|
default:
|
||||||
|
style = style.Foreground(ctx.Style.oddRows)
|
||||||
|
}
|
||||||
|
return style
|
||||||
|
})
|
||||||
|
t.Row(cmd.Name, snakeCaseToTitleCase(inputKind), name)
|
||||||
|
|
||||||
|
fmt.Fprintln(ctx.Out, t.Render())
|
||||||
|
|
||||||
|
if cmd.Verbose {
|
||||||
|
deviceListResp, err := ctx.Client.Inputs.GetInputPropertiesListPropertyItems(
|
||||||
|
inputs.NewGetInputPropertiesListPropertyItemsParams().
|
||||||
|
WithInputName(cmd.Name).
|
||||||
|
WithPropertyName(prop),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to get device list: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
t := table.New().Border(lipgloss.RoundedBorder()).
|
||||||
|
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
|
||||||
|
t.StyleFunc(func(row, col int) lipgloss.Style {
|
||||||
|
style := lipgloss.NewStyle().Padding(0, 3)
|
||||||
|
switch col {
|
||||||
|
case 0:
|
||||||
|
style = style.Align(lipgloss.Left)
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case row == table.HeaderRow:
|
||||||
|
style = style.Bold(true).Align(lipgloss.Center)
|
||||||
|
case row%2 == 0:
|
||||||
|
style = style.Foreground(ctx.Style.evenRows)
|
||||||
|
default:
|
||||||
|
style = style.Foreground(ctx.Style.oddRows)
|
||||||
|
}
|
||||||
|
return style
|
||||||
|
})
|
||||||
|
|
||||||
|
t.Headers("Devices")
|
||||||
|
|
||||||
|
for _, item := range deviceListResp.PropertyItems {
|
||||||
|
if item.ItemName != "" {
|
||||||
|
t.Row(item.ItemName)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Fprintln(ctx.Out, t.Render())
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func device(ctx *context, inputName string) (string, string) {
|
||||||
|
settings, err := ctx.Client.Inputs.GetInputSettings(
|
||||||
|
inputs.NewGetInputSettingsParams().WithInputName(inputName),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return "", ""
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, propName := range []string{"device", "device_id"} {
|
||||||
|
deviceListResp, err := ctx.Client.Inputs.GetInputPropertiesListPropertyItems(
|
||||||
|
inputs.NewGetInputPropertiesListPropertyItemsParams().
|
||||||
|
WithInputName(inputName).
|
||||||
|
WithPropertyName(propName),
|
||||||
|
)
|
||||||
|
if err == nil && len(deviceListResp.PropertyItems) > 0 {
|
||||||
|
for _, item := range deviceListResp.PropertyItems {
|
||||||
|
if item.ItemValue == settings.InputSettings[propName] {
|
||||||
|
return propName, item.ItemName
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return "", ""
|
||||||
|
}
|
||||||
|
|
||||||
|
// InputUpdateCmd provides a command to update input settings.
|
||||||
|
type InputUpdateCmd struct {
|
||||||
|
InputName string `arg:"" help:"Name of the input to update." required:""`
|
||||||
|
DeviceName string `arg:"" help:"Name of the device to set." required:""`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run executes the command to update input settings.
|
||||||
|
func (cmd *InputUpdateCmd) Run(ctx *context) error {
|
||||||
|
// Use the device helper to find the correct device property name
|
||||||
|
prop, _ := device(ctx, cmd.InputName)
|
||||||
|
if prop == "" {
|
||||||
|
return fmt.Errorf("no device property found for input '%s'", cmd.InputName)
|
||||||
|
}
|
||||||
|
|
||||||
|
resp, err := ctx.Client.Inputs.GetInputPropertiesListPropertyItems(
|
||||||
|
inputs.NewGetInputPropertiesListPropertyItemsParams().
|
||||||
|
WithInputName(cmd.InputName).
|
||||||
|
WithPropertyName(prop),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
var deviceValue any
|
||||||
|
var found bool
|
||||||
|
for _, item := range resp.PropertyItems {
|
||||||
|
if item.ItemName == cmd.DeviceName {
|
||||||
|
deviceValue = item.ItemValue
|
||||||
|
found = true
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if !found {
|
||||||
|
return fmt.Errorf("device '%s' not found for input '%s'", cmd.DeviceName, cmd.InputName)
|
||||||
|
}
|
||||||
|
|
||||||
|
sresp, err := ctx.Client.Inputs.GetInputSettings(
|
||||||
|
inputs.NewGetInputSettingsParams().WithInputName(cmd.InputName),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
settings := make(map[string]any)
|
||||||
|
maps.Copy(settings, sresp.InputSettings)
|
||||||
|
settings[prop] = deviceValue
|
||||||
|
|
||||||
|
_, err = ctx.Client.Inputs.SetInputSettings(
|
||||||
|
inputs.NewSetInputSettingsParams().
|
||||||
|
WithInputName(cmd.InputName).
|
||||||
|
WithInputSettings(settings),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to update input settings: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Fprintf(ctx.Out, "Input %s %s set to %s\n",
|
||||||
|
ctx.Style.Highlight(cmd.InputName), prop, ctx.Style.Highlight(cmd.DeviceName))
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// InputKindDefaultsCmd provides a command to get default settings for an input kind.
|
||||||
|
type InputKindDefaultsCmd struct {
|
||||||
|
Kind string `arg:"" help:"Input kind to get default settings for." required:""`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run executes the command to get default settings for an input kind.
|
||||||
|
func (cmd *InputKindDefaultsCmd) Run(ctx *context) error {
|
||||||
|
resp, err := ctx.Client.Inputs.GetInputDefaultSettings(
|
||||||
|
inputs.NewGetInputDefaultSettingsParams().
|
||||||
|
WithInputKind(cmd.Kind),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("failed to get default settings for input kind '%s': %w", cmd.Kind, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
t := table.New().Border(lipgloss.RoundedBorder()).
|
||||||
|
BorderStyle(lipgloss.NewStyle().Foreground(ctx.Style.border))
|
||||||
|
t.Headers("Setting", "Value")
|
||||||
|
t.StyleFunc(func(row, col int) lipgloss.Style {
|
||||||
|
style := lipgloss.NewStyle().Padding(0, 3)
|
||||||
|
switch col {
|
||||||
|
case 0:
|
||||||
|
style = style.Align(lipgloss.Left)
|
||||||
|
case 1:
|
||||||
|
style = style.Align(lipgloss.Center)
|
||||||
|
}
|
||||||
|
switch {
|
||||||
|
case row == table.HeaderRow:
|
||||||
|
style = style.Bold(true).Align(lipgloss.Center)
|
||||||
|
case row%2 == 0:
|
||||||
|
style = style.Foreground(ctx.Style.evenRows)
|
||||||
|
default:
|
||||||
|
style = style.Foreground(ctx.Style.oddRows)
|
||||||
|
}
|
||||||
|
return style
|
||||||
|
})
|
||||||
|
|
||||||
|
keys := make([]string, 0, len(resp.DefaultInputSettings))
|
||||||
|
for k := range resp.DefaultInputSettings {
|
||||||
|
keys = append(keys, k)
|
||||||
|
}
|
||||||
|
sort.Strings(keys)
|
||||||
|
|
||||||
|
for _, key := range keys {
|
||||||
|
value := resp.DefaultInputSettings[key]
|
||||||
|
t.Row(key, fmt.Sprintf("%v", value))
|
||||||
|
}
|
||||||
|
|
||||||
|
fmt.Fprintln(ctx.Out, t.Render())
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|||||||
37
main.go
37
main.go
@@ -8,6 +8,8 @@ import (
|
|||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
|
"runtime/debug"
|
||||||
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/alecthomas/kong"
|
"github.com/alecthomas/kong"
|
||||||
@@ -16,6 +18,19 @@ import (
|
|||||||
kongdotenv "github.com/titusjaka/kong-dotenv-go"
|
kongdotenv "github.com/titusjaka/kong-dotenv-go"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
var version string // Version of the CLI, set at build time.
|
||||||
|
|
||||||
|
// VersionFlag is a custom flag type that prints the version and exits.
|
||||||
|
type VersionFlag string
|
||||||
|
|
||||||
|
func (v VersionFlag) Decode(_ *kong.DecodeContext) error { return nil } // nolint: revive
|
||||||
|
func (v VersionFlag) IsBool() bool { return true } // nolint: revive
|
||||||
|
func (v VersionFlag) BeforeApply(app *kong.Kong, vars kong.Vars) error { // nolint: revive, unparam
|
||||||
|
fmt.Printf("gobs-cli version: %s\n", vars["version"])
|
||||||
|
app.Exit(0)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
// ObsConfig holds the configuration for connecting to the OBS WebSocket server.
|
// ObsConfig holds the configuration for connecting to the OBS WebSocket server.
|
||||||
type ObsConfig struct {
|
type ObsConfig struct {
|
||||||
Host string `flag:"host" help:"Host to connect to." default:"localhost" env:"OBS_HOST" short:"H"`
|
Host string `flag:"host" help:"Host to connect to." default:"localhost" env:"OBS_HOST" short:"H"`
|
||||||
@@ -31,7 +46,7 @@ type StyleConfig struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// CLI is the main command line interface structure.
|
// CLI is the main command line interface structure.
|
||||||
// It embeds the ObsConfig struct to inherit its fields and flags.
|
// It embeds ObsConfig and StyleConfig to provide configuration options.
|
||||||
type CLI struct {
|
type CLI struct {
|
||||||
ObsConfig `embed:"" help:"OBS WebSocket configuration."`
|
ObsConfig `embed:"" help:"OBS WebSocket configuration."`
|
||||||
StyleConfig `embed:"" help:"Style configuration."`
|
StyleConfig `embed:"" help:"Style configuration."`
|
||||||
@@ -44,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"`
|
||||||
@@ -81,10 +97,25 @@ func main() {
|
|||||||
var cli CLI
|
var cli CLI
|
||||||
ctx := kong.Parse(
|
ctx := kong.Parse(
|
||||||
&cli,
|
&cli,
|
||||||
kong.Name("GOBS-CLI"),
|
kong.Name("gobs-cli"),
|
||||||
kong.Description("A command line tool to interact with OBS Websocket."),
|
kong.Description("A command line tool to interact with OBS Websocket."),
|
||||||
kong.Configuration(kongdotenv.ENVFileReader, ".env", filepath.Join(userConfigDir, "gobs-cli", "config.env")),
|
kong.Configuration(kongdotenv.ENVFileReader, ".env", filepath.Join(userConfigDir, "gobs-cli", "config.env")),
|
||||||
)
|
kong.UsageOnError(),
|
||||||
|
kong.ConfigureHelp(kong.HelpOptions{
|
||||||
|
Compact: true,
|
||||||
|
}),
|
||||||
|
kong.Vars{
|
||||||
|
"version": func() string {
|
||||||
|
if version == "" {
|
||||||
|
info, ok := debug.ReadBuildInfo()
|
||||||
|
if !ok {
|
||||||
|
return "(unable to read build info)"
|
||||||
|
}
|
||||||
|
version = strings.Split(info.Main.Version, "-")[0]
|
||||||
|
}
|
||||||
|
return version
|
||||||
|
}(),
|
||||||
|
})
|
||||||
|
|
||||||
client, err := connectObs(cli.ObsConfig)
|
client, err := connectObs(cli.ObsConfig)
|
||||||
ctx.FatalIfErrorf(err)
|
ctx.FatalIfErrorf(err)
|
||||||
|
|||||||
@@ -204,6 +204,9 @@ func (cmd *RecordSplitCmd) Run(ctx *context) error {
|
|||||||
if !status.OutputActive {
|
if !status.OutputActive {
|
||||||
return fmt.Errorf("recording is not in progress")
|
return fmt.Errorf("recording is not in progress")
|
||||||
}
|
}
|
||||||
|
if status.OutputPaused {
|
||||||
|
return fmt.Errorf("recording is paused, cannot split")
|
||||||
|
}
|
||||||
|
|
||||||
_, err = ctx.Client.Record.SplitRecordFile()
|
_, err = ctx.Client.Record.SplitRecordFile()
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -229,6 +232,9 @@ func (cmd *RecordChapterCmd) Run(ctx *context) error {
|
|||||||
if !status.OutputActive {
|
if !status.OutputActive {
|
||||||
return fmt.Errorf("recording is not in progress")
|
return fmt.Errorf("recording is not in progress")
|
||||||
}
|
}
|
||||||
|
if status.OutputPaused {
|
||||||
|
return fmt.Errorf("recording is paused, cannot create chapter")
|
||||||
|
}
|
||||||
|
|
||||||
var params *record.CreateRecordChapterParams
|
var params *record.CreateRecordChapterParams
|
||||||
if cmd.ChapterName == "" {
|
if cmd.ChapterName == "" {
|
||||||
|
|||||||
@@ -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
|
||||||
|
}
|
||||||
30
version.go
30
version.go
@@ -2,38 +2,8 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"runtime/debug"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/alecthomas/kong"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
var version string
|
|
||||||
|
|
||||||
// VersionFlag is a custom flag type for displaying version information.
|
|
||||||
type VersionFlag string
|
|
||||||
|
|
||||||
// Decode implements the kong.Flag interface.
|
|
||||||
func (v VersionFlag) Decode(_ *kong.DecodeContext) error { return nil }
|
|
||||||
|
|
||||||
// IsBool implements the kong.Flag interface.
|
|
||||||
func (v VersionFlag) IsBool() bool { return true }
|
|
||||||
|
|
||||||
// BeforeApply implements the kong.Flag interface.
|
|
||||||
func (v VersionFlag) BeforeApply(app *kong.Kong, _ kong.Vars) error { // nolint: unparam
|
|
||||||
if version == "" {
|
|
||||||
info, ok := debug.ReadBuildInfo()
|
|
||||||
if !ok {
|
|
||||||
return fmt.Errorf("failed to read build info")
|
|
||||||
}
|
|
||||||
version = strings.Split(info.Main.Version, "-")[0]
|
|
||||||
}
|
|
||||||
|
|
||||||
fmt.Printf("gobs-cli version: %s\n", version)
|
|
||||||
app.Exit(0) // Exit the application after printing the version
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ObsVersionCmd handles the version command.
|
// ObsVersionCmd handles the version command.
|
||||||
type ObsVersionCmd struct{} // size = 0x0
|
type ObsVersionCmd struct{} // size = 0x0
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user