mirror of
https://github.com/onyx-and-iris/gobs-cli.git
synced 2026-04-18 07:03:37 +00:00
Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 7da80a1ad2 | |||
| ea4ca2aeb9 | |||
| d2f0a64180 | |||
| f01fd0ca84 | |||
| 10d50df445 | |||
| 06cefe58ed |
14
CHANGELOG.md
14
CHANGELOG.md
@@ -5,6 +5,20 @@ 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.13.2] - 2025-06-26
|
||||
|
||||
### 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.
|
||||
|
||||
# [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
|
||||
|
||||
15
README.md
15
README.md
@@ -313,6 +313,21 @@ gobs-cli record directory "/home/me/obs-vids/"
|
||||
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
|
||||
|
||||
- start: Start streaming.
|
||||
|
||||
36
main.go
36
main.go
@@ -8,6 +8,8 @@ import (
|
||||
"io"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"runtime/debug"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"github.com/alecthomas/kong"
|
||||
@@ -16,6 +18,19 @@ import (
|
||||
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.
|
||||
type ObsConfig struct {
|
||||
Host string `flag:"host" help:"Host to connect to." default:"localhost" env:"OBS_HOST" short:"H"`
|
||||
@@ -31,7 +46,7 @@ type StyleConfig struct {
|
||||
}
|
||||
|
||||
// CLI is the main command line interface structure.
|
||||
// It embeds the ObsConfig struct to inherit its fields and flags.
|
||||
// It embeds ObsConfig and StyleConfig to provide configuration options.
|
||||
type CLI struct {
|
||||
ObsConfig `embed:"" help:"OBS WebSocket configuration."`
|
||||
StyleConfig `embed:"" help:"Style configuration."`
|
||||
@@ -81,10 +96,25 @@ func main() {
|
||||
var cli CLI
|
||||
ctx := kong.Parse(
|
||||
&cli,
|
||||
kong.Name("GOBS-CLI"),
|
||||
kong.Name("gobs-cli"),
|
||||
kong.Description("A command line tool to interact with OBS Websocket."),
|
||||
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)
|
||||
ctx.FatalIfErrorf(err)
|
||||
|
||||
82
record.go
82
record.go
@@ -4,17 +4,20 @@ import (
|
||||
"fmt"
|
||||
|
||||
"github.com/andreykaipov/goobs/api/requests/config"
|
||||
"github.com/andreykaipov/goobs/api/requests/record"
|
||||
)
|
||||
|
||||
// RecordCmd handles the recording commands.
|
||||
type RecordCmd struct {
|
||||
Start RecordStartCmd `cmd:"" help:"Start recording." aliases:"s"`
|
||||
Stop RecordStopCmd `cmd:"" help:"Stop recording." aliases:"st"`
|
||||
Toggle RecordToggleCmd `cmd:"" help:"Toggle recording." aliases:"tg"`
|
||||
Status RecordStatusCmd `cmd:"" help:"Show recording status." aliases:"ss"`
|
||||
Pause RecordPauseCmd `cmd:"" help:"Pause recording." aliases:"p"`
|
||||
Resume RecordResumeCmd `cmd:"" help:"Resume recording." aliases:"r"`
|
||||
Directory RecordDirectoryCmd `cmd:"" help:"Get/Set recording directory." aliases:"d"`
|
||||
Start RecordStartCmd `cmd:"" help:"Start recording." aliases:"s"`
|
||||
Stop RecordStopCmd `cmd:"" help:"Stop recording." aliases:"st"`
|
||||
Toggle RecordToggleCmd `cmd:"" help:"Toggle recording." aliases:"tg"`
|
||||
Status RecordStatusCmd `cmd:"" help:"Show recording status." aliases:"ss"`
|
||||
Pause RecordPauseCmd `cmd:"" help:"Pause recording." aliases:"p"`
|
||||
Resume RecordResumeCmd `cmd:"" help:"Resume recording." aliases:"r"`
|
||||
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.
|
||||
@@ -187,3 +190,68 @@ func (cmd *RecordDirectoryCmd) Run(ctx *context) error {
|
||||
fmt.Fprintf(ctx.Out, "Recording directory set to: %s\n", ctx.Style.Highlight(cmd.RecordDirectory))
|
||||
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
|
||||
}
|
||||
|
||||
30
version.go
30
version.go
@@ -2,38 +2,8 @@ package main
|
||||
|
||||
import (
|
||||
"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.
|
||||
type ObsVersionCmd struct{} // size = 0x0
|
||||
|
||||
|
||||
Reference in New Issue
Block a user