Compare commits

..

16 Commits

Author SHA1 Message Date
8a5ce67ba0 add 0.15.0 to CHANGELOG 2026-01-08 15:36:12 +00:00
474693e0f7 add new input subcommands to README 2026-01-08 15:33:56 +00:00
a960c9ffa5 reorder commands
add input kind-defaults
2026-01-08 15:31:02 +00:00
8ce8727a0a rename input kinds to input list-kinds
rename input delete to input remove

add input volume
2026-01-08 14:14:40 +00:00
Noah Zoschke
fba7c4ce20 format 2025-07-30 07:02:27 -07:00
Noah Zoschke
c5e7bb4e1a delete 2025-07-29 16:35:10 -07:00
Noah Zoschke
e087fdefe3 update 2025-07-29 16:29:52 -07:00
Noah Zoschke
bd4a6cad4b show verbose 2025-07-29 16:18:56 -07:00
Noah Zoschke
72fc7d4092 kinds 2025-07-29 15:55:44 -07:00
Noah Zoschke
cb735cd666 show 2025-07-29 15:33:22 -07:00
Noah Zoschke
db70f8766d create input 2025-07-29 14:30:49 -07:00
c6406888a9 display (empty) if no text is set 2025-07-14 03:44:12 +01:00
f65af8298d add 0.14.0 to CHANGELOG 2025-07-14 03:34:18 +01:00
1dfb6f87ac add TextCmd to README 2025-07-14 03:33:58 +01:00
866aedde7c add text command group 2025-07-14 03:33:49 +01:00
9eb6c8a282 use red in example 2025-06-27 13:53:55 +01:00
5 changed files with 532 additions and 5 deletions

View File

@@ -5,6 +5,18 @@ 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 # [0.13.3] - 2025-06-27
### Changed ### Changed

View File

@@ -77,7 +77,7 @@ gobs-cli --style="red" --no-border sceneitem list
Or with environment variables: Or with environment variables:
```env ```env
GOBS_STYLE=cyan GOBS_STYLE=red
GOBS_STYLE_NO_BORDER=true GOBS_STYLE_NO_BORDER=true
``` ```
@@ -264,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:
@@ -281,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
@@ -302,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.

365
input.go
View File

@@ -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 {
Create InputCreateCmd `cmd:"" help:"Create input." aliases:"c"`
Remove InputRemoveCmd `cmd:"" help:"Remove input." aliases:"d"`
List InputListCmd `cmd:"" help:"List all inputs." aliases:"ls"` List InputListCmd `cmd:"" help:"List all inputs." aliases:"ls"`
ListKinds InputListKindsCmd `cmd:"" help:"List input kinds." aliases:"k"`
Mute InputMuteCmd `cmd:"" help:"Mute input." aliases:"m"` Mute InputMuteCmd `cmd:"" help:"Mute input." aliases:"m"`
Unmute InputUnmuteCmd `cmd:"" help:"Unmute input." aliases:"um"` Unmute InputUnmuteCmd `cmd:"" help:"Unmute input." aliases:"um"`
Toggle InputToggleCmd `cmd:"" help:"Toggle input." aliases:"tg"` 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
}

View File

@@ -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"`

85
text.go Normal file
View 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
}