add 0.10.3 to CHANGELOG

add Muted column to table

CHANGELOG.md

@@ -5,17 +5,39 @@ 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.9.0]
+# [0.10.3] - 2025-06-07
 
 ### Added
 
--   --version/-v option. See [VersionFlag](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#versionflag)
+-   filter list:
+    -   --ffmpeg, --vlc flags
+    -   Muted column to list table
+
+# [0.10.2] - 2025-06-04
+
+### Added
+
+-   screenshot save command, see [ScreenshotCmd](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#screenshotcmd)
+
+### Fixed
+
+-   filter list:
+    -   sourceName arg now defaults to current scene. 
+    -   defaults are printed for any unmodified values.
+-   sceneitem list:
+    -   prints enabled mark instead of true/false
+
+# [0.9.0] - 2025-06-02
+
+### Added
+
+-   --version/-v option. See [Flags](https://github.com/onyx-and-iris/gobs-cli?tab=readme-ov-file#flags)
 
 ### Changed
 
 -   version command renamed to obs-version
 
-# [0.8.2]
+# [0.8.2] - 2025-05-29
 
 ### Added
 

README.md

@@ -14,10 +14,16 @@ go install github.com/onyx-and-iris/gobs-cli@latest
 
 #### Flags
 
-Pass `--host`, `--port` and `--password` as flags to the root command, for example:
+-   --host/-H: Websocket host
+-   --port/-P Websocket port
+-   --password/-p: Websocket password
+-   --timeout/-T: Websocket timeout
+-   --version/-v: Print the gobs-cli version
+
+Pass `--host`, `--port` and `--password` as flags on the root command, for example:
 
 ```console
-gobs-cli --host=localhost --port=4455 --password=<websocket password> --help
+gobs-cli --host localhost --port 4455 --password 'websocket password' --help
 ```
 
 #### Environment Variables
@@ -37,14 +43,6 @@ OBS_TIMEOUT=5
 
 ## Commands
 
-### VersionFlag
-
--   --version/-v: Print gobs-cli version information and quit
-
-```console
-gobs-cli --version
-```
-
 ### ObsVersionCmd
 
 -   Print OBS client and websocket version.
@@ -225,6 +223,8 @@ gobs-cli group status START "test_group"
         -   --input: List all inputs.
         -   --output: List all outputs.
         -   --colour: List all colour sources.
+        -   --ffmpeg: List all ffmpeg sources.
+        -   --vlc: List all VLC sources.
 
 ```console
 gobs-cli input list
@@ -515,6 +515,10 @@ gobs-cli hotkey trigger-sequence OBS_KEY_F1 --shift --ctrl
 
 -   list: List all filters.
 
+    *optional*
+    -   args: SourceName
+        -   defaults to current scene
+
 ```console
 gobs-cli filter list
 ```
@@ -563,7 +567,7 @@ gobs-cli projector list-monitors
             -   defaults to 0
 
     *optional*
-    -   args: <source_name>
+    -   args: SourceName
         -   defaults to current scene
 
 ```console
@@ -574,6 +578,25 @@ gobs-cli projector open --monitor-index=1 "test_scene"
 gobs-cli projector open --monitor-index=1 "test_group"
 ```
 
+### ScreenshotCmd
+
+-   save: Take a screenshot and save it to a file.
+    -   flags:
+
+        *optional*
+        -   --width:
+            -   defaults to 1920
+        -   --height:
+            -   defaults to 1080
+        -   --quality:
+            -   defaults to -1
+
+    -   args: SourceName FilePath
+
+```console
+gobs-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
+```
+
 
 [userconfigdir]: https://pkg.go.dev/os#UserConfigDir
 [obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h

Taskfile.yaml

@@ -7,6 +7,8 @@ vars:
   PROGRAM: gobs-cli
   SHELL: '{{if eq .OS "Windows_NT"}}powershell{{end}}'
   BIN_DIR: bin
+  VERSION:
+    sh: 'git describe --tags $(git rev-list --tags --max-count=1)'
 
 tasks:
   default:
@@ -35,13 +37,13 @@ tasks:
   build-windows:
     desc: Build the gobs-cli project for Windows
     cmds:
-      - GOOS=windows GOARCH=amd64 go build -ldflags "-X 'main.version=debug'" -o {{.BIN_DIR}}/{{.PROGRAM}}_windows_amd64.exe
+      - GOOS=windows GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_windows_amd64.exe
     internal: true
 
   build-linux:
     desc: Build the gobs-cli project for Linux
     cmds:
-      - GOOS=linux GOARCH=amd64 go build -ldflags "-X 'main.version=debug'" -o {{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64
+      - GOOS=linux GOARCH=amd64 go build -ldflags "-X 'main.version={{.VERSION}}'" -o {{.BIN_DIR}}/{{.PROGRAM}}_linux_amd64
     internal: true
 
   test:

filter.go

@@ -2,6 +2,7 @@ package main
 
 import (
 	"fmt"
+	"maps"
 	"sort"
 	"strings"
 
@@ -20,19 +21,27 @@ type FilterCmd struct {
 
 // 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."`
+	SourceName string `arg:"" help:"Name of the source to list filters from." default:""`
 }
 
 // Run executes the command to list all filters in a scene.
 func (cmd *FilterListCmd) Run(ctx *context) error {
-	filters, err := ctx.Client.Filters.GetSourceFilterList(
+	if cmd.SourceName == "" {
+		currentScene, err := ctx.Client.Scenes.GetCurrentProgramScene()
+		if err != nil {
+			return fmt.Errorf("failed to get current program scene: %w", err)
+		}
+		cmd.SourceName = currentScene.SceneName
+	}
+
+	sourceFilters, err := ctx.Client.Filters.GetSourceFilterList(
 		filters.NewGetSourceFilterListParams().WithSourceName(cmd.SourceName),
 	)
 	if err != nil {
 		return err
 	}
 
-	if len(filters.Filters) == 0 {
+	if len(sourceFilters.Filters) == 0 {
 		fmt.Fprintf(ctx.Out, "No filters found for source %s.\n", cmd.SourceName)
 		return nil
 	}
@@ -42,10 +51,20 @@ func (cmd *FilterListCmd) Run(ctx *context) error {
 	t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignCenter, table.AlignLeft)
 	t.SetHeaders("Filter Name", "Kind", "Enabled", "Settings")
 
-	for _, filter := range filters.Filters {
+	for _, filter := range sourceFilters.Filters {
+		defaultSettings, err := ctx.Client.Filters.GetSourceFilterDefaultSettings(
+			filters.NewGetSourceFilterDefaultSettingsParams().
+				WithFilterKind(filter.FilterKind),
+		)
+		if err != nil {
+			return fmt.Errorf("failed to get default settings for filter %s: %w",
+				filter.FilterName, err)
+		}
+		maps.Insert(defaultSettings.DefaultFilterSettings, maps.All(filter.FilterSettings))
+
 		var lines []string
-		for k, v := range filter.FilterSettings {
-			lines = append(lines, fmt.Sprintf("%s %v", k, v))
+		for k, v := range defaultSettings.DefaultFilterSettings {
+			lines = append(lines, fmt.Sprintf("%s: %v", snakeCaseToTitleCase(k), v))
 		}
 		sort.Slice(lines, func(i, j int) bool {
 			return strings.ToLower(lines[i]) < strings.ToLower(lines[j])

input.go

@@ -21,6 +21,8 @@ type InputListCmd struct {
 	Input  bool `flag:"" help:"List all inputs."         aliases:"i"`
 	Output bool `flag:"" help:"List all outputs."        aliases:"o"`
 	Colour bool `flag:"" help:"List all colour sources." aliases:"c"`
+	Ffmpeg bool `flag:"" help:"List all ffmpeg sources." aliases:"f"`
+	Vlc    bool `flag:"" help:"List all VLC sources."    aliases:"v"`
 }
 
 // Run executes the command to list all inputs.
@@ -32,22 +34,47 @@ func (cmd *InputListCmd) Run(ctx *context) error {
 
 	t := table.New(ctx.Out)
 	t.SetPadding(3)
-	t.SetAlignment(table.AlignLeft, table.AlignLeft)
-	t.SetHeaders("Input Name", "Kind")
+	t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignCenter)
+	t.SetHeaders("Input Name", "Kind", "Muted")
 
 	for _, input := range resp.Inputs {
-		if cmd.Input && strings.Contains(input.InputKind, "input") {
-			t.AddRow(input.InputName, input.InputKind)
+		var muteMark string
+		for _, kind := range []string{"input", "output", "ffmpeg", "vlc"} {
+			if strings.Contains(input.InputKind, kind) {
+				resp, err := ctx.Client.Inputs.GetInputMute(
+					inputs.NewGetInputMuteParams().WithInputName(input.InputName),
+				)
+				if err != nil {
+					return fmt.Errorf("failed to get input mute state: %w", err)
 				}
-		if cmd.Output && strings.Contains(input.InputKind, "output") {
-			t.AddRow(input.InputName, input.InputKind)
+				muteMark = getEnabledMark(resp.InputMuted)
+				break
 			}
-		if cmd.Colour && strings.Contains(input.InputKind, "color") { // nolint
-			t.AddRow(input.InputName, input.InputKind)
 		}
 
-		if !cmd.Input && !cmd.Output && !cmd.Colour {
-			t.AddRow(input.InputName, input.InputKind)
+		type filter struct {
+			enabled bool
+			keyword string
+		}
+		filters := []filter{
+			{cmd.Input, "input"},
+			{cmd.Output, "output"},
+			{cmd.Colour, "color"}, // nolint: misspell
+			{cmd.Ffmpeg, "ffmpeg"},
+			{cmd.Vlc, "vlc"},
+		}
+
+		var added bool
+		for _, f := range filters {
+			if f.enabled && strings.Contains(input.InputKind, f.keyword) {
+				t.AddRow(input.InputName, input.InputKind, muteMark)
+				added = true
+				break
+			}
+		}
+
+		if !added && (!cmd.Input && !cmd.Output && !cmd.Colour && !cmd.Ffmpeg && !cmd.Vlc) {
+			t.AddRow(input.InputName, input.InputKind, muteMark)
 		}
 	}
 	t.Render()

main.go

@@ -18,10 +18,10 @@ import (
 
 // ObsConfig holds the configuration for connecting to the OBS WebSocket server.
 type ObsConfig struct {
-	Host     string `flag:"host"     help:"Host to connect to."          default:"localhost" env:"OBS_HOST"`
-	Port     int    `flag:"port"     help:"Port to connect to."          default:"4455"      env:"OBS_PORT"`
-	Password string `flag:"password" help:"Password for authentication." default:""          env:"OBS_PASSWORD"`
-	Timeout  int    `flag:"timeout"  help:"Timeout in seconds."          default:"5"         env:"OBS_TIMEOUT"`
+	Host     string `flag:"host"     help:"Host to connect to."          default:"localhost" env:"OBS_HOST"     short:"H"`
+	Port     int    `flag:"port"     help:"Port to connect to."          default:"4455"      env:"OBS_PORT"     short:"P"`
+	Password string `flag:"password" help:"Password for authentication." default:""          env:"OBS_PASSWORD" short:"p"`
+	Timeout  int    `flag:"timeout"  help:"Timeout in seconds."          default:"5"         env:"OBS_TIMEOUT"  short:"T"`
 }
 
 // CLI is the main command line interface structure.
@@ -47,6 +47,7 @@ type CLI struct {
 	Hotkey          HotkeyCmd          `help:"Manage hotkeys."                         cmd:"" aliases:"hk"`
 	Filter          FilterCmd          `help:"Manage filters."                         cmd:"" aliases:"f"`
 	Projector       ProjectorCmd       `help:"Manage projectors."                      cmd:"" aliases:"prj"`
+	Screenshot      ScreenshotCmd      `help:"Take screenshots."                       cmd:"" aliases:"ss"`
 }
 
 type context struct {

sceneitem.go

@@ -71,11 +71,11 @@ func (cmd *SceneItemListCmd) Run(ctx *context) error {
 					fmt.Sprintf("%d", groupItem.SceneItemID),
 					groupItem.SourceName,
 					item.SourceName,
-					fmt.Sprintf("%t", item.SceneItemEnabled && groupItem.SceneItemEnabled),
+					getEnabledMark(item.SceneItemEnabled && groupItem.SceneItemEnabled),
 				)
 			}
 		} else {
-			t.AddRow(fmt.Sprintf("%d", item.SceneItemID), item.SourceName, "", fmt.Sprintf("%t", item.SceneItemEnabled))
+			t.AddRow(fmt.Sprintf("%d", item.SceneItemID), item.SourceName, "", getEnabledMark(item.SceneItemEnabled))
 		}
 	}
 	t.Render()

screenshot.go

@@ -0,0 +1,41 @@
+package main
+
+import (
+	"fmt"
+	"path/filepath"
+
+	"github.com/andreykaipov/goobs/api/requests/sources"
+)
+
+// ScreenshotCmd provides commands to manage screenshots in OBS Studio.
+type ScreenshotCmd struct {
+	Save ScreenshotSaveCmd `cmd:"" help:"Take a screenshot and save it to a file." aliases:"sv"`
+}
+
+// ScreenshotSaveCmd represents the command to save a screenshot of a source in OBS.
+type ScreenshotSaveCmd struct {
+	SourceName string  `arg:"" help:"Name of the source to take a screenshot of."`
+	FilePath   string  `arg:"" help:"Path to the file where the screenshot will be saved."`
+	Width      float64 `       help:"Width of the screenshot in pixels."                   flag:"" default:"1920"`
+	Height     float64 `       help:"Height of the screenshot in pixels."                  flag:"" default:"1080"`
+	Quality    float64 `       help:"Quality of the screenshot (1-100)."                   flag:"" default:"-1"`
+}
+
+// Run executes the command to take a screenshot and save it to a file.
+func (cmd *ScreenshotSaveCmd) Run(ctx *context) error {
+	_, err := ctx.Client.Sources.SaveSourceScreenshot(
+		sources.NewSaveSourceScreenshotParams().
+			WithSourceName(cmd.SourceName).
+			WithImageFormat(trimPrefix(filepath.Ext(cmd.FilePath), ".")).
+			WithImageFilePath(cmd.FilePath).
+			WithImageWidth(cmd.Width).
+			WithImageHeight(cmd.Height).
+			WithImageCompressionQuality(cmd.Quality),
+	)
+	if err != nil {
+		return fmt.Errorf("failed to take screenshot: %w", err)
+	}
+
+	fmt.Fprintf(ctx.Out, "Screenshot saved to %s.\n", cmd.FilePath)
+	return nil
+}

util.go

@@ -20,3 +20,10 @@ func getEnabledMark(enabled bool) string {
 	}
 	return "\u274c" // red cross mark
 }
+
+func trimPrefix(s, prefix string) string {
+	if strings.HasPrefix(s, prefix) {
+		return s[len(prefix):]
+	}
+	return s
+}

version.go

@@ -2,11 +2,13 @@ package main
 
 import (
 	"fmt"
+	"runtime/debug"
+	"strings"
 
 	"github.com/alecthomas/kong"
 )
 
-var version = "unknown"
+var version string
 
 // VersionFlag is a custom flag type for displaying version information.
 type VersionFlag string
@@ -18,8 +20,16 @@ func (v VersionFlag) Decode(_ *kong.DecodeContext) error { return nil }
 func (v VersionFlag) IsBool() bool { return true }
 
 // BeforeApply implements the kong.Flag interface for VersionFlag.
-func (v VersionFlag) BeforeApply(app *kong.Kong, _ kong.Vars) error {
-	fmt.Println(version)
+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
 }