add filter commands

upd README, CHANGELOG

CHANGELOG.md

@@ -5,11 +5,26 @@ 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/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-# [0.4.0] - 2025-05-07
+# [0.6.0] - 2025-05-25
+
+### Added
+
+-   filter commands, see [Filter](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#filter)
+
+# [0.5.0] - 2025-05-22
+
+### Added
+
+-   hotkey commands, see [Hotkey](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#hotkeycmd)
+
+# [0.4.2] - 2025-05-08
 
 ### Added
 
 -   replaybuffer toggle command
+-   studiomode enable/disable now print output to console
+-   stream start/stop now print output to console
+-   Unit tests
 
 # [0.3.1] - 2025-05-02
 
@@ -28,4 +43,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
--   Initial release.
+-   Initial release.

README.md

@@ -443,4 +443,76 @@ gobs-cli virtualcam toggle
 gobs-cli virtualcam status
 ```
 
-[userconfigdir]: https://pkg.go.dev/os#UserConfigDir
+### HotkeyCmd
+
+-   list: List all hotkeys.
+
+```console
+gobs-cli hotkey list
+```
+
+-   trigger: Trigger a hotkey by name.
+
+```console
+gobs-cli hotkey trigger OBSBasic.StartStreaming
+
+gobs-cli hotkey trigger OBSBasic.StopStreaming
+```
+
+-   trigger-sequence: Trigger a hotkey by sequence.
+    -   flags:
+
+        *optional*
+        -   --shift: Press shift.
+        -   --ctrl: Press control.
+        -   --alt: Press alt.
+        -   --cmd: Press command (mac).
+
+    -   args: keyID
+        -   Check [obs-hotkeys.h][obs-keyids] for a full list of OBS key ids.
+
+```console
+gobs-cli hotkey trigger-sequence OBS_KEY_F1 --ctrl
+
+gobs-cli hotkey trigger-sequence OBS_KEY_F1 --shift --ctrl
+```
+
+### FilterCmd
+
+-   list: List all filters.
+
+```console
+gobs-cli filter list
+```
+
+-   enable: Enable filter.
+    -   args: SourceName FilterName
+
+```console
+gobs-cli enable 'Mic/Aux' 'Gain'
+```
+
+-   disable: Disable filter.
+    -   args: SourceName FilterName
+
+```console
+gobs-cli disable 'Mic/Aux' 'Gain'
+```
+
+-   toggle: Toggle filter.
+    -   args: SourceName FilterName
+
+```console
+gobs-cli toggle 'Mic/Aux' 'Gain'
+```
+
+-   status: Get filter status.
+    -   args: SourceName FilterName
+
+```console
+gobs-cli status 'Mic/Aux' 'Gain'
+```
+
+
+[userconfigdir]: https://pkg.go.dev/os#UserConfigDir
+[obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h

filter.go

@@ -0,0 +1,149 @@
+package main
+
+import (
+	"fmt"
+
+	"github.com/andreykaipov/goobs/api/requests/filters"
+)
+
+// FilterCmd provides commands to manage filters in OBS Studio.
+type FilterCmd struct {
+	List    FilterListCmd    `cmd:"" help:"List all filters."  aliases:"ls"`
+	Enable  FilterEnableCmd  `cmd:"" help:"Enable filter."     aliases:"on"`
+	Disable FilterDisableCmd `cmd:"" help:"Disable filter."    aliases:"off"`
+	Toggle  FilterToggleCmd  `cmd:"" help:"Toggle filter."     aliases:"tg"`
+	Status  FilterStatusCmd  `cmd:"" help:"Get filter status." aliases:"ss"`
+}
+
+// FilterListCmd provides a command to list all filters in a scene.
+type FilterListCmd struct {
+	SourceName string `arg:"" help:"Name of the source to list filters from."`
+}
+
+// Run executes the command to list all filters in a scene.
+func (cmd *FilterListCmd) Run(ctx *context) error {
+	filters, err := ctx.Client.Filters.GetSourceFilterList(
+		filters.NewGetSourceFilterListParams().WithSourceName(cmd.SourceName),
+	)
+	if err != nil {
+		return err
+	}
+	for _, filter := range filters.Filters {
+		fmt.Fprintf(ctx.Out, "Name: %s\n  Kind: %s\n  Enabled: %t\n  Settings: %+v\n",
+			filter.FilterName, filter.FilterKind, filter.FilterEnabled, filter.FilterSettings)
+	}
+	return nil
+}
+
+// FilterEnableCmd provides a command to enable a filter in a scene.
+type FilterEnableCmd struct {
+	SourceName string `arg:"" help:"Name of the source to enable filter from."`
+	FilterName string `arg:"" help:"Name of the filter to enable."`
+}
+
+// Run executes the command to enable a filter in a scene.
+func (cmd *FilterEnableCmd) Run(ctx *context) error {
+	_, err := ctx.Client.Filters.SetSourceFilterEnabled(
+		filters.NewSetSourceFilterEnabledParams().
+			WithSourceName(cmd.SourceName).
+			WithFilterName(cmd.FilterName).
+			WithFilterEnabled(true),
+	)
+	if err != nil {
+		return fmt.Errorf("failed to enable filter %s on source %s: %w",
+			cmd.FilterName, cmd.SourceName, err)
+	}
+	fmt.Fprintf(ctx.Out, "Filter %s enabled on source %s.\n",
+		cmd.FilterName, cmd.SourceName)
+	return nil
+}
+
+// FilterDisableCmd provides a command to disable a filter in a scene.
+type FilterDisableCmd struct {
+	SourceName string `arg:"" help:"Name of the source to disable filter from."`
+	FilterName string `arg:"" help:"Name of the filter to disable."`
+}
+
+// Run executes the command to disable a filter in a scene.
+func (cmd *FilterDisableCmd) Run(ctx *context) error {
+	_, err := ctx.Client.Filters.SetSourceFilterEnabled(
+		filters.NewSetSourceFilterEnabledParams().
+			WithSourceName(cmd.SourceName).
+			WithFilterName(cmd.FilterName).
+			WithFilterEnabled(false),
+	)
+	if err != nil {
+		return fmt.Errorf("failed to disable filter %s on source %s: %w",
+			cmd.FilterName, cmd.SourceName, err)
+	}
+	fmt.Fprintf(ctx.Out, "Filter %s disabled on source %s.\n",
+		cmd.FilterName, cmd.SourceName)
+	return nil
+}
+
+// FilterToggleCmd provides a command to toggle a filter in a scene.
+type FilterToggleCmd struct {
+	SourceName string `arg:"" help:"Name of the source to toggle filter from."`
+	FilterName string `arg:"" help:"Name of the filter to toggle."`
+}
+
+// Run executes the command to toggle a filter in a scene.
+func (cmd *FilterToggleCmd) Run(ctx *context) error {
+	filter, err := ctx.Client.Filters.GetSourceFilter(
+		filters.NewGetSourceFilterParams().
+			WithSourceName(cmd.SourceName).
+			WithFilterName(cmd.FilterName),
+	)
+	if err != nil {
+		return fmt.Errorf("failed to get filter %s on source %s: %w",
+			cmd.FilterName, cmd.SourceName, err)
+	}
+
+	newStatus := !filter.FilterEnabled
+	_, err = ctx.Client.Filters.SetSourceFilterEnabled(
+		filters.NewSetSourceFilterEnabledParams().
+			WithSourceName(cmd.SourceName).
+			WithFilterName(cmd.FilterName).
+			WithFilterEnabled(newStatus),
+	)
+	if err != nil {
+		return fmt.Errorf("failed to toggle filter %s on source %s: %w",
+			cmd.FilterName, cmd.SourceName, err)
+	}
+
+	if newStatus {
+		fmt.Fprintf(ctx.Out, "Filter %s on source %s is now enabled.\n",
+			cmd.FilterName, cmd.SourceName)
+	} else {
+		fmt.Fprintf(ctx.Out, "Filter %s on source %s is now disabled.\n",
+			cmd.FilterName, cmd.SourceName)
+	}
+	return nil
+}
+
+// FilterStatusCmd provides a command to get the status of a filter in a scene.
+type FilterStatusCmd struct {
+	SourceName string `arg:"" help:"Name of the source to get filter status from."`
+	FilterName string `arg:"" help:"Name of the filter to get status."`
+}
+
+// Run executes the command to get the status of a filter in a scene.
+func (cmd *FilterStatusCmd) Run(ctx *context) error {
+	filter, err := ctx.Client.Filters.GetSourceFilter(
+		filters.NewGetSourceFilterParams().
+			WithSourceName(cmd.SourceName).
+			WithFilterName(cmd.FilterName),
+	)
+	if err != nil {
+		return fmt.Errorf("failed to get status of filter %s on source %s: %w",
+			cmd.FilterName, cmd.SourceName, err)
+	}
+	if filter.FilterEnabled {
+		fmt.Fprintf(ctx.Out, "Filter %s on source %s is enabled.\n",
+			cmd.FilterName, cmd.SourceName)
+	} else {
+		fmt.Fprintf(ctx.Out, "Filter %s on source %s is disabled.\n",
+			cmd.FilterName, cmd.SourceName)
+	}
+	return nil
+}

hotkey.go

@@ -0,0 +1,74 @@
+package main
+
+import (
+	"fmt"
+
+	"github.com/andreykaipov/goobs/api/requests/general"
+	"github.com/andreykaipov/goobs/api/typedefs"
+)
+
+// HotkeyCmd provides commands to manage hotkeys in OBS Studio.
+type HotkeyCmd struct {
+	List            HotkeyListCmd            `cmd:"" help:"List all hotkeys."             aliases:"ls"`
+	Trigger         HotkeyTriggerCmd         `cmd:"" help:"Trigger a hotkey by name."     aliases:"tr"`
+	TriggerSequence HotkeyTriggerSequenceCmd `cmd:"" help:"Trigger a hotkey by sequence." aliases:"trs"`
+}
+
+// HotkeyListCmd provides a command to list all hotkeys.
+type HotkeyListCmd struct{} // size = 0x0
+
+// Run executes the command to list all hotkeys.
+func (cmd *HotkeyListCmd) Run(ctx *context) error {
+	resp, err := ctx.Client.General.GetHotkeyList()
+	if err != nil {
+		return err
+	}
+
+	for _, hotkey := range resp.Hotkeys {
+		fmt.Fprintln(ctx.Out, hotkey)
+	}
+	return nil
+}
+
+// HotkeyTriggerCmd provides a command to trigger a hotkey.
+type HotkeyTriggerCmd struct {
+	Hotkey string `help:"Hotkey name to trigger." arg:""`
+}
+
+// Run executes the command to trigger a hotkey.
+func (cmd *HotkeyTriggerCmd) Run(ctx *context) error {
+	_, err := ctx.Client.General.TriggerHotkeyByName(
+		general.NewTriggerHotkeyByNameParams().WithHotkeyName(cmd.Hotkey),
+	)
+	if err != nil {
+		return err
+	}
+	return nil
+}
+
+// HotkeyTriggerSequenceCmd provides a command to trigger a hotkey sequence.
+type HotkeyTriggerSequenceCmd struct {
+	Shift bool   `flag:"" help:"Shift modifier."`
+	Ctrl  bool   `flag:"" help:"Control modifier."`
+	Alt   bool   `flag:"" help:"Alt modifier."`
+	Cmd   bool   `flag:"" help:"Command modifier."`
+	KeyID string `        help:"Key ID to trigger." arg:""`
+}
+
+// Run executes the command to trigger a hotkey sequence.
+func (cmd *HotkeyTriggerSequenceCmd) Run(ctx *context) error {
+	_, err := ctx.Client.General.TriggerHotkeyByKeySequence(
+		general.NewTriggerHotkeyByKeySequenceParams().
+			WithKeyId(cmd.KeyID).
+			WithKeyModifiers(&typedefs.KeyModifiers{
+				Shift:   cmd.Shift,
+				Control: cmd.Ctrl,
+				Alt:     cmd.Alt,
+				Command: cmd.Cmd,
+			}),
+	)
+	if err != nil {
+		return err
+	}
+	return nil
+}

main.go

@@ -24,9 +24,9 @@ type ObsConfig struct {
 	Timeout  int    `flag:"timeout"  help:"Timeout in seconds."          default:"5"         env:"OBS_TIMEOUT"`
 }
 
-// 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.
-type cli struct {
+type CLI struct {
 	ObsConfig `embed:"" help:"OBS WebSocket configuration."`
 
 	Man mangokong.ManFlag `help:"Print man page."`
@@ -43,6 +43,8 @@ type cli struct {
 	Replaybuffer    ReplayBufferCmd    `help:"Manage replay buffer."     cmd:"" aliases:"rb"`
 	Studiomode      StudioModeCmd      `help:"Manage studio mode."       cmd:"" aliases:"sm"`
 	Virtualcam      VirtualCamCmd      `help:"Manage virtual camera."    cmd:"" aliases:"vc"`
+	Hotkey          HotkeyCmd          `help:"Manage hotkeys."           cmd:"" aliases:"hk"`
+	Filter          FilterCmd          `help:"Manage filters."           cmd:"" aliases:"f"`
 }
 
 type context struct {
@@ -57,7 +59,7 @@ func main() {
 		os.Exit(1)
 	}
 
-	var cli cli
+	var cli CLI
 	ctx := kong.Parse(
 		&cli,
 		kong.Name("GOBS-CLI"),