mirror of
https://github.com/onyx-and-iris/gobs-cli.git
synced 2025-06-10 05:30:34 +01:00
Compare commits
12 Commits
Author | SHA1 | Date | |
---|---|---|---|
d9c0e40d8f | |||
42ab45b9fb | |||
27c3c5369b | |||
0a0c75ae51 | |||
cf5da68137 | |||
14d9feb43e | |||
8204d6520d | |||
1d590eb788 | |||
29fe6fedfb | |||
ee47832cd6 | |||
17b8e53da3 | |||
92761ab1b3 |
28
CHANGELOG.md
28
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/),
|
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.9.0]
|
# [0.10.3] - 2025-06-07
|
||||||
|
|
||||||
### Added
|
### 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
|
### Changed
|
||||||
|
|
||||||
- version command renamed to obs-version
|
- version command renamed to obs-version
|
||||||
|
|
||||||
# [0.8.2]
|
# [0.8.2] - 2025-05-29
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
|
27
README.md
27
README.md
@ -223,6 +223,8 @@ gobs-cli group status START "test_group"
|
|||||||
- --input: List all inputs.
|
- --input: List all inputs.
|
||||||
- --output: List all outputs.
|
- --output: List all outputs.
|
||||||
- --colour: List all colour sources.
|
- --colour: List all colour sources.
|
||||||
|
- --ffmpeg: List all ffmpeg sources.
|
||||||
|
- --vlc: List all VLC sources.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
gobs-cli input list
|
gobs-cli input list
|
||||||
@ -513,6 +515,10 @@ gobs-cli hotkey trigger-sequence OBS_KEY_F1 --shift --ctrl
|
|||||||
|
|
||||||
- list: List all filters.
|
- list: List all filters.
|
||||||
|
|
||||||
|
*optional*
|
||||||
|
- args: SourceName
|
||||||
|
- defaults to current scene
|
||||||
|
|
||||||
```console
|
```console
|
||||||
gobs-cli filter list
|
gobs-cli filter list
|
||||||
```
|
```
|
||||||
@ -561,7 +567,7 @@ gobs-cli projector list-monitors
|
|||||||
- defaults to 0
|
- defaults to 0
|
||||||
|
|
||||||
*optional*
|
*optional*
|
||||||
- args: <source_name>
|
- args: SourceName
|
||||||
- defaults to current scene
|
- defaults to current scene
|
||||||
|
|
||||||
```console
|
```console
|
||||||
@ -572,6 +578,25 @@ gobs-cli projector open --monitor-index=1 "test_scene"
|
|||||||
gobs-cli projector open --monitor-index=1 "test_group"
|
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
|
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir
|
||||||
[obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h
|
[obs-keyids]: https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h
|
@ -7,6 +7,8 @@ vars:
|
|||||||
PROGRAM: gobs-cli
|
PROGRAM: gobs-cli
|
||||||
SHELL: '{{if eq .OS "Windows_NT"}}powershell{{end}}'
|
SHELL: '{{if eq .OS "Windows_NT"}}powershell{{end}}'
|
||||||
BIN_DIR: bin
|
BIN_DIR: bin
|
||||||
|
VERSION:
|
||||||
|
sh: 'git describe --tags $(git rev-list --tags --max-count=1)'
|
||||||
|
|
||||||
tasks:
|
tasks:
|
||||||
default:
|
default:
|
||||||
@ -35,13 +37,13 @@ tasks:
|
|||||||
build-windows:
|
build-windows:
|
||||||
desc: Build the gobs-cli project for Windows
|
desc: Build the gobs-cli project for Windows
|
||||||
cmds:
|
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
|
internal: true
|
||||||
|
|
||||||
build-linux:
|
build-linux:
|
||||||
desc: Build the gobs-cli project for Linux
|
desc: Build the gobs-cli project for Linux
|
||||||
cmds:
|
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
|
internal: true
|
||||||
|
|
||||||
test:
|
test:
|
||||||
|
31
filter.go
31
filter.go
@ -2,6 +2,7 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"maps"
|
||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
@ -20,19 +21,27 @@ type FilterCmd struct {
|
|||||||
|
|
||||||
// FilterListCmd provides a command to list all filters in a scene.
|
// FilterListCmd provides a command to list all filters in a scene.
|
||||||
type FilterListCmd struct {
|
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.
|
// Run executes the command to list all filters in a scene.
|
||||||
func (cmd *FilterListCmd) Run(ctx *context) error {
|
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),
|
filters.NewGetSourceFilterListParams().WithSourceName(cmd.SourceName),
|
||||||
)
|
)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
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)
|
fmt.Fprintf(ctx.Out, "No filters found for source %s.\n", cmd.SourceName)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
@ -42,10 +51,20 @@ func (cmd *FilterListCmd) Run(ctx *context) error {
|
|||||||
t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignCenter, table.AlignLeft)
|
t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignCenter, table.AlignLeft)
|
||||||
t.SetHeaders("Filter Name", "Kind", "Enabled", "Settings")
|
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
|
var lines []string
|
||||||
for k, v := range filter.FilterSettings {
|
for k, v := range defaultSettings.DefaultFilterSettings {
|
||||||
lines = append(lines, fmt.Sprintf("%s %v", k, v))
|
lines = append(lines, fmt.Sprintf("%s: %v", snakeCaseToTitleCase(k), v))
|
||||||
}
|
}
|
||||||
sort.Slice(lines, func(i, j int) bool {
|
sort.Slice(lines, func(i, j int) bool {
|
||||||
return strings.ToLower(lines[i]) < strings.ToLower(lines[j])
|
return strings.ToLower(lines[i]) < strings.ToLower(lines[j])
|
||||||
|
51
input.go
51
input.go
@ -21,6 +21,8 @@ type InputListCmd struct {
|
|||||||
Input bool `flag:"" help:"List all inputs." aliases:"i"`
|
Input bool `flag:"" help:"List all inputs." aliases:"i"`
|
||||||
Output bool `flag:"" help:"List all outputs." aliases:"o"`
|
Output bool `flag:"" help:"List all outputs." aliases:"o"`
|
||||||
Colour bool `flag:"" help:"List all colour sources." aliases:"c"`
|
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.
|
// 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 := table.New(ctx.Out)
|
||||||
t.SetPadding(3)
|
t.SetPadding(3)
|
||||||
t.SetAlignment(table.AlignLeft, table.AlignLeft)
|
t.SetAlignment(table.AlignLeft, table.AlignLeft, table.AlignCenter)
|
||||||
t.SetHeaders("Input Name", "Kind")
|
t.SetHeaders("Input Name", "Kind", "Muted")
|
||||||
|
|
||||||
for _, input := range resp.Inputs {
|
for _, input := range resp.Inputs {
|
||||||
if cmd.Input && strings.Contains(input.InputKind, "input") {
|
var muteMark string
|
||||||
t.AddRow(input.InputName, input.InputKind)
|
for _, kind := range []string{"input", "output", "ffmpeg", "vlc"} {
|
||||||
}
|
if strings.Contains(input.InputKind, kind) {
|
||||||
if cmd.Output && strings.Contains(input.InputKind, "output") {
|
resp, err := ctx.Client.Inputs.GetInputMute(
|
||||||
t.AddRow(input.InputName, input.InputKind)
|
inputs.NewGetInputMuteParams().WithInputName(input.InputName),
|
||||||
}
|
)
|
||||||
if cmd.Colour && strings.Contains(input.InputKind, "color") { // nolint
|
if err != nil {
|
||||||
t.AddRow(input.InputName, input.InputKind)
|
return fmt.Errorf("failed to get input mute state: %w", err)
|
||||||
|
}
|
||||||
|
muteMark = getEnabledMark(resp.InputMuted)
|
||||||
|
break
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if !cmd.Input && !cmd.Output && !cmd.Colour {
|
type filter struct {
|
||||||
t.AddRow(input.InputName, input.InputKind)
|
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()
|
t.Render()
|
||||||
|
1
main.go
1
main.go
@ -47,6 +47,7 @@ type CLI struct {
|
|||||||
Hotkey HotkeyCmd `help:"Manage hotkeys." cmd:"" aliases:"hk"`
|
Hotkey HotkeyCmd `help:"Manage hotkeys." cmd:"" aliases:"hk"`
|
||||||
Filter FilterCmd `help:"Manage filters." cmd:"" aliases:"f"`
|
Filter FilterCmd `help:"Manage filters." cmd:"" aliases:"f"`
|
||||||
Projector ProjectorCmd `help:"Manage projectors." cmd:"" aliases:"prj"`
|
Projector ProjectorCmd `help:"Manage projectors." cmd:"" aliases:"prj"`
|
||||||
|
Screenshot ScreenshotCmd `help:"Take screenshots." cmd:"" aliases:"ss"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type context struct {
|
type context struct {
|
||||||
|
@ -71,11 +71,11 @@ func (cmd *SceneItemListCmd) Run(ctx *context) error {
|
|||||||
fmt.Sprintf("%d", groupItem.SceneItemID),
|
fmt.Sprintf("%d", groupItem.SceneItemID),
|
||||||
groupItem.SourceName,
|
groupItem.SourceName,
|
||||||
item.SourceName,
|
item.SourceName,
|
||||||
fmt.Sprintf("%t", item.SceneItemEnabled && groupItem.SceneItemEnabled),
|
getEnabledMark(item.SceneItemEnabled && groupItem.SceneItemEnabled),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
} else {
|
} 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()
|
t.Render()
|
||||||
|
41
screenshot.go
Normal file
41
screenshot.go
Normal file
@ -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
|
||||||
|
}
|
7
util.go
7
util.go
@ -20,3 +20,10 @@ func getEnabledMark(enabled bool) string {
|
|||||||
}
|
}
|
||||||
return "\u274c" // red cross mark
|
return "\u274c" // red cross mark
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func trimPrefix(s, prefix string) string {
|
||||||
|
if strings.HasPrefix(s, prefix) {
|
||||||
|
return s[len(prefix):]
|
||||||
|
}
|
||||||
|
return s
|
||||||
|
}
|
||||||
|
12
version.go
12
version.go
@ -2,11 +2,13 @@ package main
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"runtime/debug"
|
||||||
|
"strings"
|
||||||
|
|
||||||
"github.com/alecthomas/kong"
|
"github.com/alecthomas/kong"
|
||||||
)
|
)
|
||||||
|
|
||||||
var version = "unknown"
|
var version string
|
||||||
|
|
||||||
// VersionFlag is a custom flag type for displaying version information.
|
// VersionFlag is a custom flag type for displaying version information.
|
||||||
type VersionFlag string
|
type VersionFlag string
|
||||||
@ -19,6 +21,14 @@ func (v VersionFlag) IsBool() bool { return true }
|
|||||||
|
|
||||||
// BeforeApply implements the kong.Flag interface for VersionFlag.
|
// BeforeApply implements the kong.Flag interface for VersionFlag.
|
||||||
func (v VersionFlag) BeforeApply(app *kong.Kong, _ kong.Vars) error { // nolint: unparam
|
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)
|
fmt.Printf("gobs-cli version: %s\n", version)
|
||||||
app.Exit(0) // Exit the application after printing the version
|
app.Exit(0) // Exit the application after printing the version
|
||||||
return nil
|
return nil
|
||||||
|
Loading…
x
Reference in New Issue
Block a user