obsws-cli/CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.24.8] - 2026-02-07

Changed

• --debug flag removed and replaced with --loglevel. See Flags. This gives the user more control over the level of logging. The default level has been set to WARNING.

Fixed

• shell completion now works, see Shell Completion. Unfortunately, command aliases in the help output are no longer present as it was breaking shell completion. However, the aliases do still work. See issue #3

[0.24.6] - 2026-01-26

Changed

• environment variables should now be prefixed with 'OBSWS_CLI_', see Environment Variables

[0.24.0] - 2026-01-09

Added

• new subcommands added to input, see Input
• settings command group, see Settings
• media command group, see Media

[0.20.0] - 2025-07-14

Added

• text command group, see Text

[0.19.0] - 2025-06-23

Added

• record split and record chapter commands, see Record
  • As of OBS 30.2.0, the only file format supporting record chapter is Hybrid MP4.

[0.18.0] - 2025-06-21

Added

• Various colouring styles, see Style
  • 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.

[0.17.3] - 2025-06-20

Added

• input list, scene list and sceneitem list now accept --uuid flag.
• Active column added to scene list table.

Changed

• scene list no longer prints the UUIDs by default, enable it with the --uuid flag.
• if NO_COLOR is set, print colourless check and cross marks in tables.

Fixed

• Issue with input list not printing all inputs if no filters were applied.

[0.16.8] - 2025-06-07

Added

• filter list:
  • --ffmpeg, --vlc flags
  • Muted column to list table

[0.16.5] - 2025-06-06

Added

• Disable Colouring section added to README.

Changed

• error output:
  • now printed in bold red.
  • highlights are now yellow
• normal output:
  • highlights are now green
• help messages:
  • removed a lot of the [default: None], this affects optional flags/arguments without default values.

[0.16.1] - 2025-06-04

Added

• screenshot save command, see Screenshot

Changed

• filter list:
  • source_name arg is now optional, it defaults to the current scene.
  • default values are printed if unmodified.

[0.15.0] - 2025-06-02

Added

• root typer now accepts --version/-v option, it returns the CLI version. See Flags

Changed

• version command renamed to obs-version

[0.14.2] - 2025-05-29

Changed

• The --parent flag for sceneitem commands has been renamed to --group. See Scene Item

[0.14.0] - 2025-05-27

Added

• record directory command, see directory under Record

Changed

• project open <source_name> arg now optional, if not passed the current scene will be projected
• record stop now prints the output path of the recording.

Fixed

• Index column alignment in projector list-monitors now centred.

[0.13.0] - 2025-05-26

Added

• projector commands, see projector

Changed

• list commands that result in empty lists now return exit code 0 and write to stdout.

[0.12.0] - 2025-05-23

Added

• filter commands, see Filter

[0.11.0] - 2025-05-22

Added

• hotkey commands, see Hotkey

[0.10.0] - 2025-04-27

Added

• sceneitem transform, see transform under Scene Item

[0.9.2] - 2025-04-26

Added

• Initial release.