mirror of
https://github.com/onyx-and-iris/gobs-cli.git
synced 2025-07-01 16:00:31 +01:00
Compare commits
No commits in common. "main" and "v0.12.0" have entirely different histories.
21
CHANGELOG.md
21
CHANGELOG.md
@ -5,31 +5,12 @@ 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.13.3] - 2025-06-27
|
# [0.12.0] - 2025-06-21
|
||||||
|
|
||||||
### 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
|
|
||||||
|
|
||||||
### Added
|
|
||||||
|
|
||||||
- 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
|
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
- Various colouring styles, see [Style](https://github.com/onyx-and-iris/gobs-cli/tree/main?tab=readme-ov-file#style)
|
- Various colouring styles, see [Style](https://github.com/onyx-and-iris/gobs-cli/tree/main?tab=readme-ov-file#style)
|
||||||
- colouring is applied to list tables as well as highlighted information in stdout/stderr output.
|
- colouring is applied to list tables as well as highlighted information in stdout/stderr output.
|
||||||
- table border styling may be optionally disabled with the --no-border flag.
|
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
|
76
README.md
76
README.md
@ -4,16 +4,6 @@ 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
|
||||||
@ -50,36 +40,6 @@ 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
|
||||||
|
|
||||||
@ -353,21 +313,6 @@ gobs-cli record directory "/home/me/obs-vids/"
|
|||||||
gobs-cli record directory "C:/Users/me/Videos"
|
gobs-cli record directory "C:/Users/me/Videos"
|
||||||
```
|
```
|
||||||
|
|
||||||
- split: Split recording.
|
|
||||||
|
|
||||||
```console
|
|
||||||
gobs-cli record split
|
|
||||||
```
|
|
||||||
|
|
||||||
- chapter: Create a chapter in the recording.
|
|
||||||
|
|
||||||
*optional*
|
|
||||||
- arg: ChapterName
|
|
||||||
|
|
||||||
```console
|
|
||||||
gobs-cli record chapter "Chapter Name"
|
|
||||||
```
|
|
||||||
|
|
||||||
### StreamCmd
|
### StreamCmd
|
||||||
|
|
||||||
- start: Start streaming.
|
- start: Start streaming.
|
||||||
@ -661,9 +606,26 @@ 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"
|
||||||
```
|
```
|
||||||
|
|
||||||
## License
|
## Style
|
||||||
|
|
||||||
`gobs-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
By default styling is disabled but you may enable it with the --style/-s flag.
|
||||||
|
|
||||||
|
Available options are:
|
||||||
|
|
||||||
|
- red
|
||||||
|
- magenta
|
||||||
|
- purple
|
||||||
|
- blue
|
||||||
|
- cyan
|
||||||
|
- green
|
||||||
|
- yellow
|
||||||
|
- orange
|
||||||
|
- white
|
||||||
|
- grey
|
||||||
|
- navy
|
||||||
|
- black
|
||||||
|
|
||||||
|
Alternatively you may set the style with an environment variable `GOBS_STYLE`.
|
||||||
|
|
||||||
|
|
||||||
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir
|
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir
|
||||||
|
@ -11,7 +11,7 @@ func TestFilterList(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmd := &FilterListCmd{
|
cmd := &FilterListCmd{
|
||||||
SourceName: "Mic/Aux",
|
SourceName: "Mic/Aux",
|
||||||
@ -30,7 +30,7 @@ func TestFilterListScene(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmd := &FilterListCmd{
|
cmd := &FilterListCmd{
|
||||||
SourceName: "gobs-test",
|
SourceName: "gobs-test",
|
||||||
@ -49,7 +49,7 @@ func TestFilterListEmpty(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmd := &FilterListCmd{
|
cmd := &FilterListCmd{
|
||||||
SourceName: "NonExistentSource",
|
SourceName: "NonExistentSource",
|
||||||
|
@ -11,7 +11,7 @@ func TestGroupList(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmd := &GroupListCmd{
|
cmd := &GroupListCmd{
|
||||||
SceneName: "Scene",
|
SceneName: "Scene",
|
||||||
@ -30,7 +30,7 @@ func TestGroupShow(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmd := &GroupShowCmd{
|
cmd := &GroupShowCmd{
|
||||||
SceneName: "Scene",
|
SceneName: "Scene",
|
||||||
@ -50,7 +50,7 @@ func TestGroupToggle(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmdStatus := &GroupStatusCmd{
|
cmdStatus := &GroupStatusCmd{
|
||||||
SceneName: "Scene",
|
SceneName: "Scene",
|
||||||
@ -91,7 +91,7 @@ func TestGroupStatus(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmdShow := &GroupShowCmd{
|
cmdShow := &GroupShowCmd{
|
||||||
SceneName: "Scene",
|
SceneName: "Scene",
|
||||||
|
Binary file not shown.
Before Width: | Height: | Size: 6.1 KiB |
Binary file not shown.
Before Width: | Height: | Size: 6.1 KiB |
Binary file not shown.
Before Width: | Height: | Size: 4.6 KiB |
@ -11,7 +11,7 @@ func TestInputList(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmd := &InputListCmd{}
|
cmd := &InputListCmd{}
|
||||||
err := cmd.Run(context)
|
err := cmd.Run(context)
|
||||||
@ -39,7 +39,7 @@ func TestInputListFilterInput(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmd := &InputListCmd{Input: true}
|
cmd := &InputListCmd{Input: true}
|
||||||
err := cmd.Run(context)
|
err := cmd.Run(context)
|
||||||
@ -73,7 +73,7 @@ func TestInputListFilterOutput(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmd := &InputListCmd{Output: true}
|
cmd := &InputListCmd{Output: true}
|
||||||
err := cmd.Run(context)
|
err := cmd.Run(context)
|
||||||
@ -107,7 +107,7 @@ func TestInputListFilterColour(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmd := &InputListCmd{Colour: true}
|
cmd := &InputListCmd{Colour: true}
|
||||||
err := cmd.Run(context)
|
err := cmd.Run(context)
|
||||||
|
43
main.go
43
main.go
@ -8,8 +8,6 @@ import (
|
|||||||
"io"
|
"io"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"runtime/debug"
|
|
||||||
"strings"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/alecthomas/kong"
|
"github.com/alecthomas/kong"
|
||||||
@ -18,19 +16,6 @@ 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"`
|
||||||
@ -42,11 +27,10 @@ type ObsConfig struct {
|
|||||||
// StyleConfig holds the configuration for styling the CLI output.
|
// StyleConfig holds the configuration for styling the CLI output.
|
||||||
type StyleConfig struct {
|
type StyleConfig struct {
|
||||||
Style string `help:"Style used in output." flag:"style" default:"" env:"GOBS_STYLE" short:"s" enum:",red,magenta,purple,blue,cyan,green,yellow,orange,white,grey,navy,black"`
|
Style string `help:"Style used in output." flag:"style" default:"" env:"GOBS_STYLE" short:"s" enum:",red,magenta,purple,blue,cyan,green,yellow,orange,white,grey,navy,black"`
|
||||||
NoBorder bool `help:"Disable table border styling in output." flag:"no-border" default:"false" env:"GOBS_STYLE_NO_BORDER" short:"b"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// CLI is the main command line interface structure.
|
// CLI is the main command line interface structure.
|
||||||
// It embeds ObsConfig and StyleConfig to provide configuration options.
|
// It embeds the ObsConfig struct to inherit its fields and flags.
|
||||||
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."`
|
||||||
@ -78,11 +62,11 @@ type context struct {
|
|||||||
Style *Style
|
Style *Style
|
||||||
}
|
}
|
||||||
|
|
||||||
func newContext(client *goobs.Client, out io.Writer, styleCfg StyleConfig) *context {
|
func newContext(client *goobs.Client, out io.Writer, styleName string) *context {
|
||||||
return &context{
|
return &context{
|
||||||
Client: client,
|
Client: client,
|
||||||
Out: out,
|
Out: out,
|
||||||
Style: styleFromFlag(styleCfg),
|
Style: styleFromFlag(styleName),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -96,30 +80,15 @@ 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)
|
||||||
|
|
||||||
ctx.Bind(newContext(client, os.Stdout, cli.StyleConfig))
|
ctx.Bind(newContext(client, os.Stdout, cli.StyleConfig.Style))
|
||||||
|
|
||||||
ctx.FatalIfErrorf(run(ctx, client))
|
ctx.FatalIfErrorf(run(ctx, client))
|
||||||
}
|
}
|
||||||
|
68
record.go
68
record.go
@ -4,7 +4,6 @@ import (
|
|||||||
"fmt"
|
"fmt"
|
||||||
|
|
||||||
"github.com/andreykaipov/goobs/api/requests/config"
|
"github.com/andreykaipov/goobs/api/requests/config"
|
||||||
"github.com/andreykaipov/goobs/api/requests/record"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// RecordCmd handles the recording commands.
|
// RecordCmd handles the recording commands.
|
||||||
@ -16,8 +15,6 @@ type RecordCmd struct {
|
|||||||
Pause RecordPauseCmd `cmd:"" help:"Pause recording." aliases:"p"`
|
Pause RecordPauseCmd `cmd:"" help:"Pause recording." aliases:"p"`
|
||||||
Resume RecordResumeCmd `cmd:"" help:"Resume recording." aliases:"r"`
|
Resume RecordResumeCmd `cmd:"" help:"Resume recording." aliases:"r"`
|
||||||
Directory RecordDirectoryCmd `cmd:"" help:"Get/Set recording directory." aliases:"d"`
|
Directory RecordDirectoryCmd `cmd:"" help:"Get/Set recording directory." aliases:"d"`
|
||||||
Split RecordSplitCmd `cmd:"" help:"Split recording." aliases:"sp"`
|
|
||||||
Chapter RecordChapterCmd `cmd:"" help:"Create a chapter in the recording." aliases:"c"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// RecordStartCmd starts the recording.
|
// RecordStartCmd starts the recording.
|
||||||
@ -190,68 +187,3 @@ func (cmd *RecordDirectoryCmd) Run(ctx *context) error {
|
|||||||
fmt.Fprintf(ctx.Out, "Recording directory set to: %s\n", ctx.Style.Highlight(cmd.RecordDirectory))
|
fmt.Fprintf(ctx.Out, "Recording directory set to: %s\n", ctx.Style.Highlight(cmd.RecordDirectory))
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// RecordSplitCmd splits the current recording.
|
|
||||||
type RecordSplitCmd struct{} // size = 0x0
|
|
||||||
|
|
||||||
// Run executes the command to split the recording.
|
|
||||||
func (cmd *RecordSplitCmd) Run(ctx *context) error {
|
|
||||||
status, err := ctx.Client.Record.GetRecordStatus()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if !status.OutputActive {
|
|
||||||
return fmt.Errorf("recording is not in progress")
|
|
||||||
}
|
|
||||||
if status.OutputPaused {
|
|
||||||
return fmt.Errorf("recording is paused, cannot split")
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = ctx.Client.Record.SplitRecordFile()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
fmt.Fprintln(ctx.Out, "Recording split successfully.")
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// RecordChapterCmd creates a chapter in the recording.
|
|
||||||
type RecordChapterCmd struct {
|
|
||||||
ChapterName string `arg:"" help:"Name of the chapter to create." default:""`
|
|
||||||
}
|
|
||||||
|
|
||||||
// Run executes the command to create a chapter in the recording.
|
|
||||||
func (cmd *RecordChapterCmd) Run(ctx *context) error {
|
|
||||||
status, err := ctx.Client.Record.GetRecordStatus()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if !status.OutputActive {
|
|
||||||
return fmt.Errorf("recording is not in progress")
|
|
||||||
}
|
|
||||||
if status.OutputPaused {
|
|
||||||
return fmt.Errorf("recording is paused, cannot create chapter")
|
|
||||||
}
|
|
||||||
|
|
||||||
var params *record.CreateRecordChapterParams
|
|
||||||
if cmd.ChapterName == "" {
|
|
||||||
params = record.NewCreateRecordChapterParams()
|
|
||||||
} else {
|
|
||||||
params = record.NewCreateRecordChapterParams().WithChapterName(cmd.ChapterName)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = ctx.Client.Record.CreateRecordChapter(params)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if cmd.ChapterName == "" {
|
|
||||||
cmd.ChapterName = "unnamed"
|
|
||||||
}
|
|
||||||
|
|
||||||
fmt.Fprintf(ctx.Out, "Chapter %s created successfully.\n", ctx.Style.Highlight(cmd.ChapterName))
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
@ -12,7 +12,7 @@ func TestRecordStart(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmdStatus := &RecordStatusCmd{}
|
cmdStatus := &RecordStatusCmd{}
|
||||||
err := cmdStatus.Run(context)
|
err := cmdStatus.Run(context)
|
||||||
@ -52,7 +52,7 @@ func TestRecordStop(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmdStatus := &RecordStatusCmd{}
|
cmdStatus := &RecordStatusCmd{}
|
||||||
err := cmdStatus.Run(context)
|
err := cmdStatus.Run(context)
|
||||||
@ -92,7 +92,7 @@ func TestRecordToggle(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmdStatus := &RecordStatusCmd{}
|
cmdStatus := &RecordStatusCmd{}
|
||||||
err := cmdStatus.Run(context)
|
err := cmdStatus.Run(context)
|
||||||
|
@ -11,7 +11,7 @@ func TestReplayBufferStart(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmd := &ReplayBufferStartCmd{}
|
cmd := &ReplayBufferStartCmd{}
|
||||||
err := cmd.Run(context)
|
err := cmd.Run(context)
|
||||||
@ -28,7 +28,7 @@ func TestReplayBufferStop(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmd := &ReplayBufferStopCmd{}
|
cmd := &ReplayBufferStopCmd{}
|
||||||
err := cmd.Run(context)
|
err := cmd.Run(context)
|
||||||
@ -45,7 +45,7 @@ func TestReplayBufferToggle(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmdStatus := &ReplayBufferStatusCmd{}
|
cmdStatus := &ReplayBufferStatusCmd{}
|
||||||
err := cmdStatus.Run(context)
|
err := cmdStatus.Run(context)
|
||||||
|
@ -10,7 +10,7 @@ func TestSceneList(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmd := &SceneListCmd{}
|
cmd := &SceneListCmd{}
|
||||||
err := cmd.Run(context)
|
err := cmd.Run(context)
|
||||||
@ -27,7 +27,7 @@ func TestSceneCurrent(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
// Set the current scene to "gobs-test"
|
// Set the current scene to "gobs-test"
|
||||||
cmdSwitch := &SceneSwitchCmd{
|
cmdSwitch := &SceneSwitchCmd{
|
||||||
|
@ -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.Center)
|
style = style.Align(lipgloss.Left)
|
||||||
case 1:
|
case 1:
|
||||||
style = style.Align(lipgloss.Left)
|
style = style.Align(lipgloss.Left)
|
||||||
case 2:
|
case 2:
|
||||||
|
@ -11,7 +11,7 @@ func TestSceneItemList(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmd := &SceneItemListCmd{
|
cmd := &SceneItemListCmd{
|
||||||
SceneName: "gobs-test",
|
SceneName: "gobs-test",
|
||||||
|
@ -12,7 +12,7 @@ func TestStreamStart(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmdStatus := &StreamStatusCmd{}
|
cmdStatus := &StreamStatusCmd{}
|
||||||
err := cmdStatus.Run(context)
|
err := cmdStatus.Run(context)
|
||||||
@ -51,7 +51,7 @@ func TestStreamStop(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmdStatus := &StreamStatusCmd{}
|
cmdStatus := &StreamStatusCmd{}
|
||||||
err := cmdStatus.Run(context)
|
err := cmdStatus.Run(context)
|
||||||
@ -90,7 +90,7 @@ func TestStreamToggle(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmdStatus := &StreamStatusCmd{}
|
cmdStatus := &StreamStatusCmd{}
|
||||||
err := cmdStatus.Run(context)
|
err := cmdStatus.Run(context)
|
||||||
|
@ -10,7 +10,7 @@ func TestStudioModeEnable(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmdEnable := &StudioModeEnableCmd{}
|
cmdEnable := &StudioModeEnableCmd{}
|
||||||
err := cmdEnable.Run(context)
|
err := cmdEnable.Run(context)
|
||||||
@ -38,7 +38,7 @@ func TestStudioModeDisable(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmdDisable := &StudioModeDisableCmd{}
|
cmdDisable := &StudioModeDisableCmd{}
|
||||||
err := cmdDisable.Run(context)
|
err := cmdDisable.Run(context)
|
||||||
|
102
style.go
102
style.go
@ -26,88 +26,88 @@ func (s *Style) Error(text string) string {
|
|||||||
return lipgloss.NewStyle().Foreground(lipgloss.Color("#FF0000")).Render(text) // Red for errors
|
return lipgloss.NewStyle().Foreground(lipgloss.Color("#FF0000")).Render(text) // Red for errors
|
||||||
}
|
}
|
||||||
|
|
||||||
func newRedStyle() Style {
|
func newRedStyle() *Style {
|
||||||
return Style{
|
return &Style{
|
||||||
name: "red",
|
name: "red",
|
||||||
border: lipgloss.Color("#D32F2F"), // Strong red for border
|
border: lipgloss.Color("#D32F2F"), // Strong red for border
|
||||||
oddRows: lipgloss.Color("#FFCDD2"), // Very light red for odd rows
|
oddRows: lipgloss.Color("#FFCDD2"), // Very light red for odd rows
|
||||||
evenRows: lipgloss.Color("#EF9A9A"), // Light red for even rows
|
evenRows: lipgloss.Color("#EF9A9A"), // Light red for even rows
|
||||||
highlight: lipgloss.Color("#EF9A9A"), // Highlight in light red
|
highlight: lipgloss.Color("#EF9A9A"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func newMagentaStyle() Style {
|
func newMagentaStyle() *Style {
|
||||||
return Style{
|
return &Style{
|
||||||
name: "magenta",
|
name: "magenta",
|
||||||
border: lipgloss.Color("#C2185B"), // Strong magenta for border
|
border: lipgloss.Color("#C2185B"), // Strong magenta for border
|
||||||
oddRows: lipgloss.Color("#F8BBD0"), // Very light magenta/pink for odd rows
|
oddRows: lipgloss.Color("#F8BBD0"), // Very light magenta/pink for odd rows
|
||||||
evenRows: lipgloss.Color("#F48FB1"), // Light magenta/pink for even rows
|
evenRows: lipgloss.Color("#F48FB1"), // Light magenta/pink for even rows
|
||||||
highlight: lipgloss.Color("#F48FB1"), // Highlight in light magenta/pink
|
highlight: lipgloss.Color("#F48FB1"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func newPurpleStyle() Style {
|
func newPurpleStyle() *Style {
|
||||||
return Style{
|
return &Style{
|
||||||
name: "purple",
|
name: "purple",
|
||||||
border: lipgloss.Color("#7B1FA2"), // Strong purple for border
|
border: lipgloss.Color("#7B1FA2"), // Strong purple for border
|
||||||
oddRows: lipgloss.Color("#E1BEE7"), // Very light purple for odd rows
|
oddRows: lipgloss.Color("#E1BEE7"), // Very light purple for odd rows
|
||||||
evenRows: lipgloss.Color("#CE93D8"), // Light purple for even rows
|
evenRows: lipgloss.Color("#CE93D8"), // Light purple for even rows
|
||||||
highlight: lipgloss.Color("#CE93D8"), // Highlight in light purple
|
highlight: lipgloss.Color("#CE93D8"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func newBlueStyle() Style {
|
func newBlueStyle() *Style {
|
||||||
return Style{
|
return &Style{
|
||||||
name: "blue",
|
name: "blue",
|
||||||
border: lipgloss.Color("#1976D2"), // Medium blue for border
|
border: lipgloss.Color("#1976D2"), // Medium blue for border
|
||||||
oddRows: lipgloss.Color("#E3F2FD"), // Very light blue for odd rows
|
oddRows: lipgloss.Color("#E3F2FD"), // Very light blue for odd rows
|
||||||
evenRows: lipgloss.Color("#BBDEFB"), // Light blue for even rows
|
evenRows: lipgloss.Color("#BBDEFB"), // Light blue for even rows
|
||||||
highlight: lipgloss.Color("#1976D2"), // Highlight in medium blue
|
highlight: lipgloss.Color("#1976D2"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func newCyanStyle() Style {
|
func newCyanStyle() *Style {
|
||||||
return Style{
|
return &Style{
|
||||||
name: "cyan",
|
name: "cyan",
|
||||||
border: lipgloss.Color("#00BFCF"), // A strong cyan for border
|
border: lipgloss.Color("#00BFCF"), // A strong cyan for border
|
||||||
oddRows: lipgloss.Color("#E0F7FA"), // Very light cyan for odd rows
|
oddRows: lipgloss.Color("#E0F7FA"), // Very light cyan for odd rows
|
||||||
evenRows: lipgloss.Color("#B2EBF2"), // Slightly darker light cyan for even rows
|
evenRows: lipgloss.Color("#B2EBF2"), // Slightly darker light cyan for even rows
|
||||||
highlight: lipgloss.Color("#00BFCF"), // Highlight in strong cyan
|
highlight: lipgloss.Color("#00BFCF"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func newGreenStyle() Style {
|
func newGreenStyle() *Style {
|
||||||
return Style{
|
return &Style{
|
||||||
name: "green",
|
name: "green",
|
||||||
border: lipgloss.Color("#43A047"), // Medium green for border
|
border: lipgloss.Color("#43A047"), // Medium green for border
|
||||||
oddRows: lipgloss.Color("#E8F5E9"), // Very light green for odd rows
|
oddRows: lipgloss.Color("#E8F5E9"), // Very light green for odd rows
|
||||||
evenRows: lipgloss.Color("#C8E6C9"), // Light green for even rows
|
evenRows: lipgloss.Color("#C8E6C9"), // Light green for even rows
|
||||||
highlight: lipgloss.Color("#43A047"), // Highlight in medium green
|
highlight: lipgloss.Color("#43A047"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func newYellowStyle() Style {
|
func newYellowStyle() *Style {
|
||||||
return Style{
|
return &Style{
|
||||||
name: "yellow",
|
name: "yellow",
|
||||||
border: lipgloss.Color("#FBC02D"), // Strong yellow for border
|
border: lipgloss.Color("#FBC02D"), // Strong yellow for border
|
||||||
oddRows: lipgloss.Color("#FFF9C4"), // Very light yellow for odd rows
|
oddRows: lipgloss.Color("#FFF9C4"), // Very light yellow for odd rows
|
||||||
evenRows: lipgloss.Color("#FFF59D"), // Light yellow for even rows
|
evenRows: lipgloss.Color("#FFF59D"), // Light yellow for even rows
|
||||||
highlight: lipgloss.Color("#FBC02D"), // Highlight in strong yellow
|
highlight: lipgloss.Color("#FBC02D"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func newOrangeStyle() Style {
|
func newOrangeStyle() *Style {
|
||||||
return Style{
|
return &Style{
|
||||||
name: "orange",
|
name: "orange",
|
||||||
border: lipgloss.Color("#F57C00"), // Strong orange for border
|
border: lipgloss.Color("#F57C00"), // Strong orange for border
|
||||||
oddRows: lipgloss.Color("#FFF3E0"), // Very light orange for odd rows
|
oddRows: lipgloss.Color("#FFF3E0"), // Very light orange for odd rows
|
||||||
evenRows: lipgloss.Color("#FFE0B2"), // Light orange for even rows
|
evenRows: lipgloss.Color("#FFE0B2"), // Light orange for even rows
|
||||||
highlight: lipgloss.Color("#F57C00"), // Highlight in strong orange
|
highlight: lipgloss.Color("#F57C00"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func newWhiteStyle() Style {
|
func newWhiteStyle() *Style {
|
||||||
return Style{
|
return &Style{
|
||||||
name: "white",
|
name: "white",
|
||||||
border: lipgloss.Color("#FFFFFF"), // White for border
|
border: lipgloss.Color("#FFFFFF"), // White for border
|
||||||
oddRows: lipgloss.Color("#F0F0F0"), // Very light grey for odd rows
|
oddRows: lipgloss.Color("#F0F0F0"), // Very light grey for odd rows
|
||||||
@ -116,8 +116,8 @@ func newWhiteStyle() Style {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func newGreyStyle() Style {
|
func newGreyStyle() *Style {
|
||||||
return Style{
|
return &Style{
|
||||||
name: "grey",
|
name: "grey",
|
||||||
border: lipgloss.Color("#9E9E9E"), // Medium grey for border
|
border: lipgloss.Color("#9E9E9E"), // Medium grey for border
|
||||||
oddRows: lipgloss.Color("#F5F5F5"), // Very light grey for odd rows
|
oddRows: lipgloss.Color("#F5F5F5"), // Very light grey for odd rows
|
||||||
@ -126,8 +126,8 @@ func newGreyStyle() Style {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func newNavyBlueStyle() Style {
|
func newNavyBlueStyle() *Style {
|
||||||
return Style{
|
return &Style{
|
||||||
name: "navy",
|
name: "navy",
|
||||||
border: lipgloss.Color("#001F3F"), // Navy blue for border
|
border: lipgloss.Color("#001F3F"), // Navy blue for border
|
||||||
oddRows: lipgloss.Color("#CFE2F3"), // Very light blue for odd rows
|
oddRows: lipgloss.Color("#CFE2F3"), // Very light blue for odd rows
|
||||||
@ -136,8 +136,8 @@ func newNavyBlueStyle() Style {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func newBlackStyle() Style {
|
func newBlackStyle() *Style {
|
||||||
return Style{
|
return &Style{
|
||||||
name: "black",
|
name: "black",
|
||||||
border: lipgloss.Color("#000000"), // Black for border
|
border: lipgloss.Color("#000000"), // Black for border
|
||||||
oddRows: lipgloss.Color("#333333"), // Dark grey for odd rows
|
oddRows: lipgloss.Color("#333333"), // Dark grey for odd rows
|
||||||
@ -146,34 +146,32 @@ func newBlackStyle() Style {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func styleFromFlag(cfg StyleConfig) *Style {
|
func styleFromFlag(colour string) *Style {
|
||||||
var style Style
|
switch colour {
|
||||||
|
|
||||||
switch cfg.Style {
|
|
||||||
case "red":
|
case "red":
|
||||||
style = newRedStyle()
|
return newRedStyle()
|
||||||
case "magenta":
|
case "magenta":
|
||||||
style = newMagentaStyle()
|
return newMagentaStyle()
|
||||||
case "purple":
|
case "purple":
|
||||||
style = newPurpleStyle()
|
return newPurpleStyle()
|
||||||
case "blue":
|
case "blue":
|
||||||
style = newBlueStyle()
|
return newBlueStyle()
|
||||||
case "cyan":
|
case "cyan":
|
||||||
style = newCyanStyle()
|
return newCyanStyle()
|
||||||
case "green":
|
case "green":
|
||||||
style = newGreenStyle()
|
return newGreenStyle()
|
||||||
case "yellow":
|
case "yellow":
|
||||||
style = newYellowStyle()
|
return newYellowStyle()
|
||||||
case "orange":
|
case "orange":
|
||||||
style = newOrangeStyle()
|
return newOrangeStyle()
|
||||||
case "white":
|
case "white":
|
||||||
style = newWhiteStyle()
|
return newWhiteStyle()
|
||||||
case "grey":
|
case "grey":
|
||||||
style = newGreyStyle()
|
return newGreyStyle()
|
||||||
case "navy":
|
case "navy":
|
||||||
style = newNavyBlueStyle()
|
return newNavyBlueStyle()
|
||||||
case "black":
|
case "black":
|
||||||
style = newBlackStyle()
|
return newBlackStyle()
|
||||||
default:
|
default:
|
||||||
err := os.Setenv("NO_COLOR", "1") // nolint: misspell
|
err := os.Setenv("NO_COLOR", "1") // nolint: misspell
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@ -181,12 +179,6 @@ func styleFromFlag(cfg StyleConfig) *Style {
|
|||||||
// This is a fallback to ensure that the application can still run
|
// This is a fallback to ensure that the application can still run
|
||||||
fmt.Fprintf(os.Stderr, "Error setting NO_COLOR: %v\n", err)
|
fmt.Fprintf(os.Stderr, "Error setting NO_COLOR: %v\n", err)
|
||||||
}
|
}
|
||||||
|
return &Style{}
|
||||||
}
|
}
|
||||||
|
|
||||||
// If noBorder is true, we disable the border styling
|
|
||||||
if cfg.NoBorder {
|
|
||||||
style.border = ""
|
|
||||||
}
|
|
||||||
|
|
||||||
return &style
|
|
||||||
}
|
}
|
||||||
|
30
version.go
30
version.go
@ -2,8 +2,38 @@ 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
|
||||||
|
|
||||||
|
@ -11,7 +11,7 @@ func TestVersion(t *testing.T) {
|
|||||||
defer disconnect()
|
defer disconnect()
|
||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
context := newContext(client, &out, StyleConfig{})
|
context := newContext(client, &out, "")
|
||||||
|
|
||||||
cmd := &ObsVersionCmd{}
|
cmd := &ObsVersionCmd{}
|
||||||
err := cmd.Run(context)
|
err := cmd.Run(context)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user