patch bump

set min hatch-dotenv version

.github/dependabot.yml

@@ -0,0 +1,20 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "09:00"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "09:00"

.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    environment: pypi
+    permissions:
+      # This permission is needed for private repositories.
+      contents: read
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip 
+          pip install hatch
+
+      - name: Build package
+        run: hatch build
+
+      - name: Publish on PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/ruff.yml

@@ -0,0 +1,19 @@
+name: Ruff
+
+on:
+  push:
+    branches: [main]
+
+  pull_request:
+    branches: [main]
+
+  workflow_dispatch:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/ruff-action@v3
+        with:
+          args: 'format --check --diff'

.gitignore

@@ -1,9 +1,9 @@
-# Auto-generated .gitignore by gignore: github.com/onyx-and-iris/gignore
+# Generated by ignr: github.com/onyx-and-iris/ignr
 
-### Python ###
+## Python ##
 # Byte-compiled / optimized / DLL files
 __pycache__/
-*.py[cod]
+*.py[codz]
 *$py.class
 
 # C extensions
@@ -49,7 +49,7 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *.cover
-*.py,cover
+*.py.cover
 .hypothesis/
 .pytest_cache/
 cover/
@@ -97,20 +97,35 @@ ipython_config.py
 #   install all needed dependencies.
 #Pipfile.lock
 
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
 # poetry
 #   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
 #   This is especially recommended for binary packages to ensure reproducibility, and is more
 #   commonly ignored for libraries.
 #   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
 #poetry.lock
+#poetry.toml
 
 # pdm
 #   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
 #pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/#use-with-ide
-.pdm.toml
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
 
 # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
 __pypackages__/
@@ -124,13 +139,13 @@ celerybeat.pid
 
 # Environments
 .env
+.envrc
 .venv
 env/
 venv/
 ENV/
 env.bak/
 venv.bak/
-.hatch
 .test.env
 
 # Spyder project settings
@@ -164,17 +179,38 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
-### Python Patch ###
-# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
-poetry.toml
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
 
-# ruff
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
 .ruff_cache/
 
-# LSP config files
-pyrightconfig.json
+# PyPI configuration file
+.pypirc
 
-# End of gignore: github.com/onyx-and-iris/gignore
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# End of ignr
 
 man/*.1
 test-*.py

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

CHANGELOG.md

@@ -5,11 +5,109 @@ 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.24.8] - 2026-02-07
+
+### Changed
+
+-   --debug flag removed and replaced with --loglevel. See [Flags](https://github.com/onyx-and-iris/obsws-cli/tree/main?tab=readme-ov-file#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](https://github.com/onyx-and-iris/obsws-cli/tree/main?tab=readme-ov-file#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](https://github.com/onyx-and-iris/obsws-cli/issues/3)
+
+# [0.24.6] - 2026-01-26
+
+### Changed
+
+-   environment variables should now be prefixed with 'OBSWS_CLI_', see [Environment Variables](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#environment-variables)
+
+# [0.24.0] - 2026-01-09
+
+### Added
+
+-   new subcommands added to input, see [Input](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#input)
+-   settings command group, see [Settings](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#settings)
+-   media command group, see [Media](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#media)
+
+
+# [0.20.0] - 2025-07-14
+
+### Added
+
+-   text command group, see [Text](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#text)
+
+# [0.19.0] - 2025-06-23
+
+### Added
+
+-   record split and record chapter commands, see [Record](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#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](https://github.com/onyx-and-iris/obsws-cli/tree/main?tab=readme-ov-file#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](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#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](https://github.com/onyx-and-iris/obsws-cli/tree/main?tab=readme-ov-file#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 [Root Typer](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#root-typer)
+-   root typer now accepts --version/-v option, it returns the CLI version. See [Flags](https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#flags)
 
 ### Changed
 

README.md

@@ -1,6 +1,6 @@
 # obsws-cli
 
-[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
+[![Hatch project](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pypa/hatch/master/docs/assets/badge/v0.json)](https://github.com/pypa/hatch)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 
@@ -14,7 +14,9 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
 
 - [Installation](#installation)
 - [Configuration](#configuration)
+- [Style](#style)
 - [Commands](#root-typer)
+- [Shell Completion](#shell-completion)
 - [License](#license)
 
 ## Requirements
@@ -42,7 +44,15 @@ The CLI should now be discoverable as `obsws-cli`
 
 #### 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 obsws-cli version
+-   --loglevel/-l: Set the application's logging level
+    -   One of *NOTSET, DEBUG, INFO, WARN, WARNING, ERROR, CRITICAL, FATAL*
+
+Pass `--host`, `--port` and `--password` as flags on the root command, for example:
 
 ```console
 obsws-cli --host=localhost --port=4455 --password=<websocket password> --help
@@ -55,21 +65,47 @@ Store and load environment variables from:
 -   `user home directory / .config / obsws-cli / obsws.env`
 
 ```env
-OBS_HOST=localhost
-OBS_PORT=4455
-OBS_PASSWORD=<websocket password>
+OBSWS_CLI_HOST=localhost
+OBSWS_CLI_PORT=4455
+OBSWS_CLI_PASSWORD=<websocket password>
+OBSWS_CLI_LOGLEVEL=DEBUG
 ```
 
 Flags can be used to override environment variables.
 
-## Root Typer
+## Style
 
--   --version/-v: Get the obsws-cli version:
+Styling is opt-in, by default you will get a colourless output:
+
+![colourless](./img/colourless.png)
+
+You may enable styling with the --style/-s flag:
 
 ```console
-obsws-cli --version
+obsws-cli --style="cyan" sceneitem list
 ```
 
+Available styles: _red, magenta, purple, blue, cyan, green, yellow, orange, white, grey, navy, black_
+
+![coloured](./img/coloured-border.png)
+
+Optionally you may disable border colouring with the --no-border flag:
+
+![coloured-no-border](./img/coloured-no-border.png)
+
+```console
+obsws-cli --style="cyan" --no-border sceneitem list
+```
+
+Or with environment variables:
+
+```env
+OBSWS_CLI_STYLE=cyan
+OBSWS_CLI_STYLE_NO_BORDER=true
+```
+
+## Root Typer
+
 -   obs-version: Get the OBS Client and WebSocket versions.
 
 ```console
@@ -81,6 +117,10 @@ obsws-cli obs-version
 #### Scene
 
 -   list: List all scenes.
+    -   flags:
+
+        *optional*
+        -   --uuid: Show UUIDs of scenes
 
 ```console
 obsws-cli scene list
@@ -102,6 +142,10 @@ obsws-cli scene switch LIVE
 #### Scene Item
 
 -   list: List all items in a scene.
+    -   flags:
+
+        *optional*
+        -   --uuid: Show UUIDs of scene items
 
     *optional*
     -   args: <scene_name>
@@ -258,6 +302,20 @@ obsws-cli group status START "test_group"
 
 #### Input
 
+-   create: Create a new input.
+    -   args: <input_name> <input_kind>
+
+```console
+obsws-cli input create 'stream mix' 'wasapi_input_capture'
+```
+
+-   remove: Remove an input.
+    -   args: <input_name>
+
+```console
+obsws-cli input remove 'stream mix' 
+```
+
 -   list: List all inputs.
     -   flags:
 
@@ -265,6 +323,9 @@ obsws-cli group status START "test_group"
         -   --input: Filter by input type.
         -   --output: Filter by output type.
         -   --colour: Filter by colour source type.
+        -   --ffmpeg: Filter by ffmpeg source type.
+        -   --vlc: Filter by VLC source type.
+        -   --uuid: Show UUIDs of inputs.
 
 ```console
 obsws-cli input list
@@ -272,6 +333,12 @@ obsws-cli input list
 obsws-cli input list --input --colour
 ```
 
+-   list-kinds: List all input kinds.
+
+```console
+obsws-cli input list-kinds
+```
+
 -   mute: Mute an input.
     -   args: <input_name>
 
@@ -292,6 +359,48 @@ obsws-cli input unmute "Mic/Aux"
 obsws-cli input toggle "Mic/Aux"
 ```
 
+-   volume: Set the volume of an input.
+    -   args: <input_name> <volume>
+
+```console
+obsws-cli input volume -- 'Desktop Audio' -38.9
+```
+
+-   show: Show information for an input in the current scene.
+    -   args: <input_name>
+    -   flags:
+
+        *optional*
+        -   --verbose: List all available input devices.
+
+```console
+obsws-cli input show 'Mic/Aux' --verbose
+```
+
+-   update: Name of the input to update.
+    -   args: <input_name> <device_name>
+
+```console
+obsws-cli input update 'Mic/Aux' 'Voicemeeter Out B1 (VB-Audio Voicemeeter VAIO)'
+```
+
+
+#### Text
+
+-   current: Get the current text for a text input.
+    -   args: <input_name>
+
+```console
+obsws-cli text current "My Text Input"
+```
+
+-   update: Update the text of a text input.
+    -   args: <input_name> <new_text>
+
+```console
+obsws-cli text update "My Text Input" "hi OBS!"
+```
+
 #### Record
 
 -   start: Start recording.
@@ -343,6 +452,21 @@ obsws-cli record directory "/home/me/obs-vids/"
 obsws-cli record directory "C:/Users/me/Videos"
 ```
 
+-   split: Split the current recording.
+
+```console
+obsws-cli record split
+```
+
+-   chapter: Create a chapter in the current recording.
+
+    *optional*
+    -   args: <chapter_name>
+
+```console
+obsws-cli record chapter "Chapter Name"
+```
+
 #### Stream
 
 -   start: Start streaming.
@@ -519,7 +643,10 @@ obsws-cli hotkey trigger-sequence OBS_KEY_F1 --shift --ctrl
 #### Filter
 
 -   list: List filters for a source.
+
+    *optional*
     -   args: <source_name>
+        -   defaults to current scene
 
 ```console
 obsws-cli filter list "Mic/Aux"
@@ -573,13 +700,132 @@ obsws-cli projector list-monitors
         -   defaults to current scene
 
 ```console
-obsws-cli project open
+obsws-cli projector open
 
 obsws-cli projector open --monitor-index=1 "test_scene"
 
 obsws-cli projector open --monitor-index=1 "test_group"
 ```
 
+#### Screenshot
+
+-   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: <source_name> <output_path>
+
+```console
+obsws-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
+```
+
+#### Settings
+
+-   show: Show current OBS settings.
+    -   flags:
+
+        *optional*
+        -   --video: Show video settings.
+        -   --record: Show recording settings.
+        -   --profile: Show profile settings.
+
+```console
+obsws-cli settings show --video --record
+```
+
+-   profile: Get/set OBS profile settings.
+    -   args: <category> <name> <value>
+
+```console
+obsws-cli settings profile SimpleOutput VBitrate
+
+obsws-cli settings profile SimpleOutput VBitrate 6000
+```
+
+-   stream-service: Get/set OBS stream service settings.
+    -   flags:
+        -   --key: Stream key.
+        -   --server: Stream server URL.
+
+    *optional*
+    -   args: <type>
+
+```console
+obsws-cli settings stream-service
+
+obsws-cli settings stream-service --key='live_xyzxyzxyzxyz' rtmp_common
+```
+
+-   video: Get/set OBS video settings.
+    -   flags:
+
+        *optional*
+        -   --base-width: Base (canvas) width.
+        -   --base-height: Base (canvas) height.
+        -   --output-width: Output (scaled) width.
+        -   --output-height: Output (scaled) height.
+        -   --fps-num: Frames per second numerator.
+        -   --fps-den: Frames per second denominator.
+
+```console
+obsws-cli settings video
+
+obsws-cli settings video --base-width=1920 --base-height=1080
+```
+
+#### Media
+
+-   cursor: Get/set the cursor position of a media input.
+    -   args: InputName
+
+        *optional*
+        -   TimeString
+
+```console
+obsws-cli media cursor "Media"
+
+obsws-cli media cursor "Media" "00:08:30"
+```
+
+-   play: Plays a media input.
+
+```console
+obsws-cli media play "Media"
+```
+
+-   pause: Pauses a media input.
+
+```console
+obsws-cli media pause "Media"
+```
+
+-   stop: Stops a media input.
+
+```console
+obsws-cli media stop "Media"
+```
+
+-   restart: Restarts a media input.
+
+```console
+obsws-cli media restart "Media"
+```
+
+## Shell Completion
+
+```console
+obsws-cli --install-completion
+```
+
+Currently supported shells: *bash* *zsh* *fish* *powershell*
+
 
 ## License
 
@@ -587,4 +833,5 @@ obsws-cli projector open --monitor-index=1 "test_group"
 
 
 [obs-studio]: https://obsproject.com/
-[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
+[no-colour]: https://no-color.org/

obsws_cli/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2025-present onyx-and-iris <code@onyxandiris.online>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.15.0"
+__version__ = '0.24.11'

obsws_cli/__init__.py

@@ -4,4 +4,4 @@
 
 from .app import app
 
-__all__ = ["app"]
+__all__ = ['app']

obsws_cli/alias.py

@@ -1,14 +1,10 @@
 """module defining a custom group class for handling command name aliases."""
 
-import re
-
 import typer
 
 
-class AliasGroup(typer.core.TyperGroup):
-    """A custom group class to handle command name aliases."""
-
-    _CMD_SPLIT_P = re.compile(r' ?[,|] ?')
+class RootTyperAliasGroup(typer.core.TyperGroup):
+    """A custom group class to handle command name aliases for the root typer."""
 
     def __init__(self, *args, **kwargs):
         """Initialize the AliasGroup."""
@@ -17,12 +13,41 @@ class AliasGroup(typer.core.TyperGroup):
 
     def get_command(self, ctx, cmd_name):
         """Get a command by name."""
-        cmd_name = self._group_cmd_name(cmd_name)
+        match cmd_name:
+            case 'f':
+                cmd_name = 'filter'
+            case 'g':
+                cmd_name = 'group'
+            case 'hk':
+                cmd_name = 'hotkey'
+            case 'i':
+                cmd_name = 'input'
+            case 'm':
+                cmd_name = 'media'
+            case 'prf':
+                cmd_name = 'profile'
+            case 'prj':
+                cmd_name = 'projector'
+            case 'rc':
+                cmd_name = 'record'
+            case 'rb':
+                cmd_name = 'replaybuffer'
+            case 'sc':
+                cmd_name = 'scene'
+            case 'scc':
+                cmd_name = 'scenecollection'
+            case 'si':
+                cmd_name = 'sceneitem'
+            case 'ss':
+                cmd_name = 'screenshot'
+            case 'set':
+                cmd_name = 'settings'
+            case 'st':
+                cmd_name = 'stream'
+            case 'sm':
+                cmd_name = 'studiomode'
+            case 't':
+                cmd_name = 'text'
+            case 'vc':
+                cmd_name = 'virtualcam'
         return super().get_command(ctx, cmd_name)
-
-    def _group_cmd_name(self, default_name):
-        for cmd in self.commands.values():
-            name = cmd.name
-            if name and default_name in self._CMD_SPLIT_P.split(name):
-                return name
-        return default_name

obsws_cli/app.py

@@ -1,82 +1,125 @@
 """Command line interface for the OBS WebSocket API."""
 
+import importlib
+import logging
+import pkgutil
 from typing import Annotated
 
 import obsws_python as obsws
 import typer
-from rich.console import Console
 
-from obsws_cli.__about__ import __version__ as obsws_cli_version
+from obsws_cli.__about__ import __version__ as version
 
-from . import (
-    filter,
-    group,
-    hotkey,
-    input,
-    profile,
-    projector,
-    record,
-    replaybuffer,
-    scene,
-    scenecollection,
-    sceneitem,
-    settings,
-    stream,
-    studiomode,
-    virtualcam,
-)
-from .alias import AliasGroup
+from . import commands, console, envconfig, styles
+from .alias import RootTyperAliasGroup
 
-app = typer.Typer(cls=AliasGroup)
-for module in (
-    filter,
-    group,
-    hotkey,
-    input,
-    projector,
-    profile,
-    record,
-    replaybuffer,
-    scene,
-    scenecollection,
-    sceneitem,
-    stream,
-    studiomode,
-    virtualcam,
+app = typer.Typer(cls=RootTyperAliasGroup)
+for importer, modname, ispkg in pkgutil.iter_modules(
+    commands.__path__, commands.__name__ + '.'
 ):
-    app.add_typer(module.app, name=module.__name__.split('.')[-1])
-
-out_console = Console()
-err_console = Console(stderr=True)
+    subtyper = importlib.import_module(modname)
+    app.add_typer(subtyper.app, name=modname.split('.')[-1])
 
 
 def version_callback(value: bool):
     """Show the version of the CLI."""
     if value:
-        typer.echo(f'obsws_cli version: {obsws_cli_version}')
+        console.out.print(f'obsws-cli version: {version}')
         raise typer.Exit()
 
 
+def setup_logging(loglevel: str):
+    """Set up logging for the application."""
+    level_map = logging.getLevelNamesMapping()
+    try:
+        level_int = level_map[loglevel.upper()]
+    except KeyError:
+        possible_levels = ', '.join(
+            sorted(level_map.keys(), key=lambda k: level_map[k])
+        )
+        raise typer.BadParameter(
+            f'Invalid log level: {loglevel}. Valid options are: {possible_levels}'
+        ) from None
+
+    logging.basicConfig(
+        level=level_int,
+        format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
+    )
+
+
+def validate_style(value: str):
+    """Validate and return the style."""
+    if value not in styles.registry:
+        raise typer.BadParameter(
+            f'Invalid style: {value}. Available styles: {", ".join(styles.registry.keys())}'
+        )
+    return value
+
+
 @app.callback()
 def main(
     ctx: typer.Context,
     host: Annotated[
         str,
         typer.Option(
-            envvar='OBS_HOST', help='WebSocket host', show_default='localhost'
+            '--host',
+            '-H',
+            envvar='OBSWS_CLI_HOST',
+            help='WebSocket host',
+            show_default='localhost',
         ),
-    ] = settings.get('HOST'),
+    ] = envconfig.get('host'),
     port: Annotated[
-        int, typer.Option(envvar='OBS_PORT', help='WebSocket port', show_default=4455)
-    ] = settings.get('PORT'),
+        int,
+        typer.Option(
+            '--port',
+            '-P',
+            envvar='OBSWS_CLI_PORT',
+            help='WebSocket port',
+            show_default=4455,
+        ),
+    ] = envconfig.get('port'),
     password: Annotated[
         str,
-        typer.Option(envvar='OBS_PASSWORD', help='WebSocket password', show_default=''),
-    ] = settings.get('PASSWORD'),
+        typer.Option(
+            '--password',
+            '-p',
+            envvar='OBSWS_CLI_PASSWORD',
+            help='WebSocket password',
+            show_default=False,
+        ),
+    ] = envconfig.get('password'),
     timeout: Annotated[
         int,
-        typer.Option(envvar='OBS_TIMEOUT', help='WebSocket timeout', show_default=5),
-    ] = settings.get('TIMEOUT'),
+        typer.Option(
+            '--timeout',
+            '-T',
+            envvar='OBSWS_CLI_TIMEOUT',
+            help='WebSocket timeout',
+            show_default=5,
+        ),
+    ] = envconfig.get('timeout'),
+    style: Annotated[
+        str,
+        typer.Option(
+            '--style',
+            '-s',
+            envvar='OBSWS_CLI_STYLE',
+            help='Set the style for the CLI output',
+            show_default='disabled',
+            callback=validate_style,
+        ),
+    ] = envconfig.get('style'),
+    no_border: Annotated[
+        bool,
+        typer.Option(
+            '--no-border',
+            '-b',
+            envvar='OBSWS_CLI_STYLE_NO_BORDER',
+            help='Disable table border styling in the CLI output',
+            show_default=False,
+        ),
+    ] = envconfig.get('style_no_border'),
     version: Annotated[
         bool,
         typer.Option(
@@ -88,15 +131,32 @@ def main(
             callback=version_callback,
         ),
     ] = False,
+    loglevel: Annotated[
+        str,
+        typer.Option(
+            '--loglevel',
+            '-l',
+            envvar='OBSWS_CLI_LOGLEVEL',
+            is_eager=True,
+            help='Set the logging level',
+            show_default=False,
+            callback=setup_logging,
+        ),
+    ] = envconfig.get('loglevel'),
 ):
     """obsws_cli is a command line interface for the OBS WebSocket API."""
-    ctx.obj = ctx.with_resource(obsws.ReqClient(**ctx.params))
+    ctx.ensure_object(dict)
+    ctx.obj['obsws'] = ctx.with_resource(
+        obsws.ReqClient(host=host, port=port, password=password, timeout=timeout)
+    )
+    ctx.obj['style'] = styles.request_style_obj(style, no_border)
 
 
 @app.command()
 def obs_version(ctx: typer.Context):
     """Get the OBS Client and WebSocket versions."""
-    resp = ctx.obj.get_version()
-    out_console.print(
-        f'OBS Client version: {resp.obs_version} with WebSocket version: {resp.obs_web_socket_version}'
+    resp = ctx.obj['obsws'].get_version()
+    console.out.print(
+        f'OBS Client version: {console.highlight(ctx, resp.obs_version)}'
+        f' with WebSocket version: {console.highlight(ctx, resp.obs_web_socket_version)}'
     )

obsws_cli/commands/filter.py

@@ -0,0 +1,213 @@
+"""module containing commands for manipulating filters in scenes."""
+
+from typing import Annotated, Optional
+
+import obsws_python as obsws
+import typer
+from rich.table import Table
+from rich.text import Text
+
+from obsws_cli import console, util
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Control filters in OBS scenes."""
+
+
+@app.command('list')
+@app.command('ls', hidden=True)
+def list_(
+    ctx: typer.Context,
+    source_name: Annotated[
+        Optional[str],
+        typer.Argument(
+            show_default='The current scene',
+            help='The source to list filters for',
+        ),
+    ] = None,
+):
+    """List filters for a source."""
+    if not source_name:
+        source_name = ctx.obj['obsws'].get_current_program_scene().scene_name
+
+    try:
+        resp = ctx.obj['obsws'].get_source_filter_list(source_name)
+    except obsws.error.OBSSDKRequestError as e:
+        if e.code == 600:
+            console.err.print(
+                f'No source was found by the name of [yellow]{source_name}[/yellow].'
+            )
+            raise typer.Exit(1)
+        else:
+            raise
+
+    if not resp.filters:
+        console.out.print(
+            f'No filters found for source {console.highlight(ctx, source_name)}'
+        )
+        raise typer.Exit()
+
+    table = Table(
+        title=f'Filters for Source: {source_name}',
+        padding=(0, 2),
+        border_style=ctx.obj['style'].border,
+    )
+
+    columns = [
+        (Text('Filter Name', justify='center'), 'left', ctx.obj['style'].column),
+        (Text('Kind', justify='center'), 'left', ctx.obj['style'].column),
+        (Text('Enabled', justify='center'), 'center', None),
+        (Text('Settings', justify='center'), 'center', ctx.obj['style'].column),
+    ]
+    for heading, justify, style in columns:
+        table.add_column(heading, justify=justify, style=style)
+
+    for filter in resp.filters:
+        resp = ctx.obj['obsws'].get_source_filter_default_settings(filter['filterKind'])
+        settings = resp.default_filter_settings | filter['filterSettings']
+
+        table.add_row(
+            filter['filterName'],
+            util.snakecase_to_titlecase(filter['filterKind']),
+            util.check_mark(filter['filterEnabled']),
+            '\n'.join(
+                [
+                    f'{util.snakecase_to_titlecase(k):<20} {v:>10}'
+                    for k, v in settings.items()
+                ]
+            ),
+        )
+
+    console.out.print(table)
+
+
+def _get_filter_enabled(ctx: typer.Context, source_name: str, filter_name: str):
+    """Get the status of a filter for a source."""
+    resp = ctx.obj['obsws'].get_source_filter(source_name, filter_name)
+    return resp.filter_enabled
+
+
+@app.command('enable')
+@app.command('on', hidden=True)
+def enable(
+    ctx: typer.Context,
+    source_name: Annotated[
+        str,
+        typer.Argument(
+            ..., show_default=False, help='The source to enable the filter for'
+        ),
+    ],
+    filter_name: Annotated[
+        str,
+        typer.Argument(
+            ..., show_default=False, help='The name of the filter to enable'
+        ),
+    ],
+):
+    """Enable a filter for a source."""
+    if _get_filter_enabled(ctx, source_name, filter_name):
+        console.err.print(
+            f'Filter [yellow]{filter_name}[/yellow] is already enabled for source [yellow]{source_name}[/yellow]'
+        )
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].set_source_filter_enabled(source_name, filter_name, enabled=True)
+    console.out.print(
+        f'Enabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
+    )
+
+
+@app.command('disable')
+@app.command('off', hidden=True)
+def disable(
+    ctx: typer.Context,
+    source_name: Annotated[
+        str,
+        typer.Argument(
+            ..., show_default=False, help='The source to disable the filter for'
+        ),
+    ],
+    filter_name: Annotated[
+        str,
+        typer.Argument(
+            ..., show_default=False, help='The name of the filter to disable'
+        ),
+    ],
+):
+    """Disable a filter for a source."""
+    if not _get_filter_enabled(ctx, source_name, filter_name):
+        console.err.print(
+            f'Filter [yellow]{filter_name}[/yellow] is already disabled for source [yellow]{source_name}[/yellow]'
+        )
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].set_source_filter_enabled(source_name, filter_name, enabled=False)
+    console.out.print(
+        f'Disabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
+    )
+
+
+@app.command('toggle')
+@app.command('tg', hidden=True)
+def toggle(
+    ctx: typer.Context,
+    source_name: Annotated[
+        str,
+        typer.Argument(
+            ..., show_default=False, help='The source to toggle the filter for'
+        ),
+    ],
+    filter_name: Annotated[
+        str,
+        typer.Argument(
+            ..., show_default=False, help='The name of the filter to toggle'
+        ),
+    ],
+):
+    """Toggle a filter for a source."""
+    is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
+    new_state = not is_enabled
+
+    ctx.obj['obsws'].set_source_filter_enabled(
+        source_name, filter_name, enabled=new_state
+    )
+    if new_state:
+        console.out.print(
+            f'Enabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
+        )
+    else:
+        console.out.print(
+            f'Disabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
+        )
+
+
+@app.command('status')
+@app.command('ss', hidden=True)
+def status(
+    ctx: typer.Context,
+    source_name: Annotated[
+        str,
+        typer.Argument(
+            ..., show_default=False, help='The source to get the filter status for'
+        ),
+    ],
+    filter_name: Annotated[
+        str,
+        typer.Argument(
+            ..., show_default=False, help='The name of the filter to get the status for'
+        ),
+    ],
+):
+    """Get the status of a filter for a source."""
+    is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
+    if is_enabled:
+        console.out.print(
+            f'Filter {console.highlight(ctx, filter_name)} is enabled for source {console.highlight(ctx, source_name)}'
+        )
+    else:
+        console.out.print(
+            f'Filter {console.highlight(ctx, filter_name)} is disabled for source {console.highlight(ctx, source_name)}'
+        )

obsws_cli/commands/group.py

@@ -0,0 +1,226 @@
+"""module containing commands for manipulating groups in scenes."""
+
+from typing import Annotated, Optional
+
+import typer
+from rich.table import Table
+from rich.text import Text
+
+from obsws_cli import console, util, validate
+from obsws_cli.protocols import DataclassProtocol
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Control groups in OBS scenes."""
+
+
+@app.command('list')
+@app.command('ls', hidden=True)
+def list_(
+    ctx: typer.Context,
+    scene_name: Annotated[
+        Optional[str],
+        typer.Argument(
+            show_default='The current scene',
+            help='Scene name to list groups for',
+            callback=validate.scene_in_scenes,
+        ),
+    ] = None,
+):
+    """List groups in a scene."""
+    if scene_name is None:
+        scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
+
+    resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
+    groups = [
+        (item.get('sceneItemId'), item.get('sourceName'), item.get('sceneItemEnabled'))
+        for item in resp.scene_items
+        if item.get('isGroup')
+    ]
+
+    if not groups:
+        console.out.print(
+            f'No groups found in scene {console.highlight(ctx, scene_name)}.'
+        )
+        raise typer.Exit()
+
+    table = Table(
+        title=f'Groups in Scene: {scene_name}',
+        padding=(0, 2),
+        border_style=ctx.obj['style'].border,
+    )
+
+    columns = [
+        (Text('ID', justify='center'), 'center', ctx.obj['style'].column),
+        (Text('Group Name', justify='center'), 'left', ctx.obj['style'].column),
+        (Text('Enabled', justify='center'), 'center', None),
+    ]
+    for heading, justify, style in columns:
+        table.add_column(heading, justify=justify, style=style)
+
+    for item_id, group_name, is_enabled in groups:
+        table.add_row(
+            str(item_id),
+            group_name,
+            util.check_mark(is_enabled),
+        )
+
+    console.out.print(table)
+
+
+def _get_group(group_name: str, resp: DataclassProtocol) -> dict | None:
+    """Get a group from the scene item list response."""
+    group = next(
+        (
+            item
+            for item in resp.scene_items
+            if item.get('sourceName') == group_name and item.get('isGroup')
+        ),
+        None,
+    )
+    return group
+
+
+@app.command('show')
+@app.command('sh', hidden=True)
+def show(
+    ctx: typer.Context,
+    scene_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Scene name the group is in',
+            callback=validate.scene_in_scenes,
+        ),
+    ],
+    group_name: Annotated[
+        str, typer.Argument(..., show_default=False, help='Group name to show')
+    ],
+):
+    """Show a group in a scene."""
+    resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
+    if (group := _get_group(group_name, resp)) is None:
+        console.err.print(
+            f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
+        )
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].set_scene_item_enabled(
+        scene_name=scene_name,
+        item_id=int(group.get('sceneItemId')),
+        enabled=True,
+    )
+
+    console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
+
+
+@app.command('hide')
+@app.command('h', hidden=True)
+def hide(
+    ctx: typer.Context,
+    scene_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Scene name the group is in',
+            callback=validate.scene_in_scenes,
+        ),
+    ],
+    group_name: Annotated[
+        str, typer.Argument(..., show_default=False, help='Group name to hide')
+    ],
+):
+    """Hide a group in a scene."""
+    resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
+    if (group := _get_group(group_name, resp)) is None:
+        console.err.print(
+            f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
+        )
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].set_scene_item_enabled(
+        scene_name=scene_name,
+        item_id=int(group.get('sceneItemId')),
+        enabled=False,
+    )
+
+    console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
+
+
+@app.command('toggle')
+@app.command('tg', hidden=True)
+def toggle(
+    ctx: typer.Context,
+    scene_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Scene name the group is in',
+            callback=validate.scene_in_scenes,
+        ),
+    ],
+    group_name: Annotated[
+        str, typer.Argument(..., show_default=False, help='Group name to toggle')
+    ],
+):
+    """Toggle a group in a scene."""
+    resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
+    if (group := _get_group(group_name, resp)) is None:
+        console.err.print(
+            f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
+        )
+        raise typer.Exit(1)
+
+    new_state = not group.get('sceneItemEnabled')
+    ctx.obj['obsws'].set_scene_item_enabled(
+        scene_name=scene_name,
+        item_id=int(group.get('sceneItemId')),
+        enabled=new_state,
+    )
+
+    if new_state:
+        console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
+    else:
+        console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
+
+
+@app.command('status')
+@app.command('ss', hidden=True)
+def status(
+    ctx: typer.Context,
+    scene_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Scene name the group is in',
+            callback=validate.scene_in_scenes,
+        ),
+    ],
+    group_name: Annotated[
+        str, typer.Argument(..., show_default=False, help='Group name to check status')
+    ],
+):
+    """Get the status of a group in a scene."""
+    resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
+    if (group := _get_group(group_name, resp)) is None:
+        console.err.print(
+            f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
+        )
+        raise typer.Exit(1)
+
+    enabled = ctx.obj['obsws'].get_scene_item_enabled(
+        scene_name=scene_name,
+        item_id=int(group.get('sceneItemId')),
+    )
+
+    if enabled.scene_item_enabled:
+        console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
+    else:
+        console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')

obsws_cli/commands/hotkey.py

@@ -0,0 +1,86 @@
+"""module containing commands for hotkey management."""
+
+from typing import Annotated
+
+import typer
+from rich.table import Table
+from rich.text import Text
+
+from obsws_cli import console
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Control hotkeys in OBS."""
+
+
+@app.command('list')
+@app.command('ls', hidden=True)
+def list_(
+    ctx: typer.Context,
+):
+    """List all hotkeys."""
+    resp = ctx.obj['obsws'].get_hotkey_list()
+
+    if not resp.hotkeys:
+        console.out.print('No hotkeys found.')
+        raise typer.Exit()
+
+    table = Table(
+        title='Hotkeys',
+        padding=(0, 2),
+        border_style=ctx.obj['style'].border,
+    )
+    table.add_column(
+        Text('Hotkey Name', justify='center'),
+        justify='left',
+        style=ctx.obj['style'].column,
+    )
+
+    for i, hotkey in enumerate(resp.hotkeys):
+        table.add_row(hotkey, style='' if i % 2 == 0 else 'dim')
+
+    console.out.print(table)
+
+
+@app.command('trigger')
+@app.command('tr', hidden=True)
+def trigger(
+    ctx: typer.Context,
+    hotkey: Annotated[
+        str, typer.Argument(..., show_default=False, help='The hotkey to trigger')
+    ],
+):
+    """Trigger a hotkey by name."""
+    ctx.obj['obsws'].trigger_hotkey_by_name(hotkey)
+
+
+@app.command('trigger-sequence')
+@app.command('trs', hidden=True)
+def trigger_sequence(
+    ctx: typer.Context,
+    key_id: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='The OBS key ID to trigger, see https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#hotkey for more info',
+        ),
+    ],
+    shift: Annotated[
+        bool, typer.Option(..., help='Press shift when triggering the hotkey')
+    ] = False,
+    ctrl: Annotated[
+        bool, typer.Option(..., help='Press control when triggering the hotkey')
+    ] = False,
+    alt: Annotated[
+        bool, typer.Option(..., help='Press alt when triggering the hotkey')
+    ] = False,
+    cmd: Annotated[
+        bool, typer.Option(..., help='Press cmd when triggering the hotkey')
+    ] = False,
+):
+    """Trigger a hotkey by sequence."""
+    ctx.obj['obsws'].trigger_hotkey_by_key_sequence(key_id, shift, ctrl, alt, cmd)

obsws_cli/commands/input.py

@@ -0,0 +1,465 @@
+"""module containing commands for manipulating inputs."""
+
+from typing import Annotated
+
+import obsws_python as obsws
+import typer
+from rich.table import Table
+from rich.text import Text
+
+from obsws_cli import console, util, validate
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Control inputs in OBS."""
+
+
+@app.command('create')
+@app.command('cr', hidden=True)
+def create(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Name of the input to create.',
+            callback=validate.input_not_in_inputs,
+        ),
+    ],
+    input_kind: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Kind of the input to create.',
+            callback=validate.kind_in_input_kinds,
+        ),
+    ],
+):
+    """Create a new input."""
+    current_scene = (
+        ctx.obj['obsws'].get_current_program_scene().current_program_scene_name
+    )
+    try:
+        ctx.obj['obsws'].create_input(
+            inputName=input_name,
+            inputKind=input_kind,
+            sceneItemEnabled=True,
+            sceneName=current_scene,
+            inputSettings={},
+        )
+    except obsws.error.OBSSDKRequestError as e:
+        console.err.print(f'Failed to create input: [yellow]{e}[/yellow]')
+        raise typer.Exit(1)
+
+    console.out.print(
+        f'Input {console.highlight(ctx, input_name)} of kind '
+        f'{console.highlight(ctx, input_kind)} created.',
+    )
+
+
+@app.command('remove')
+@app.command('rm', hidden=True)
+def remove(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Name of the input to remove.',
+            callback=validate.input_in_inputs,
+        ),
+    ],
+):
+    """Remove an input."""
+    ctx.obj['obsws'].remove_input(name=input_name)
+
+    console.out.print(f'Input {console.highlight(ctx, input_name)} removed.')
+
+
+@app.command('list')
+@app.command('ls', hidden=True)
+def list_(
+    ctx: typer.Context,
+    input: Annotated[bool, typer.Option(help='Filter by input type.')] = False,
+    output: Annotated[bool, typer.Option(help='Filter by output type.')] = False,
+    colour: Annotated[bool, typer.Option(help='Filter by colour source type.')] = False,
+    ffmpeg: Annotated[bool, typer.Option(help='Filter by ffmpeg source type.')] = False,
+    vlc: Annotated[bool, typer.Option(help='Filter by VLC source type.')] = False,
+    uuid: Annotated[bool, typer.Option(help='Show UUIDs of inputs.')] = False,
+):
+    """List all inputs."""
+    resp = ctx.obj['obsws'].get_input_list()
+
+    kinds = []
+    if input:
+        kinds.append('input')
+    if output:
+        kinds.append('output')
+    if colour:
+        kinds.append('color')
+    if ffmpeg:
+        kinds.append('ffmpeg')
+    if vlc:
+        kinds.append('vlc')
+    if not any([input, output, colour, ffmpeg, vlc]):
+        kinds = ctx.obj['obsws'].get_input_kind_list(False).input_kinds
+
+    inputs = sorted(
+        (
+            (input_.get('inputName'), input_.get('inputKind'), input_.get('inputUuid'))
+            for input_ in filter(
+                lambda input_: any(kind in input_.get('inputKind') for kind in kinds),
+                resp.inputs,
+            )
+        ),
+        key=lambda x: x[0],  # Sort by input name
+    )
+
+    if not inputs:
+        console.out.print('No inputs found.')
+        raise typer.Exit()
+
+    table = Table(title='Inputs', padding=(0, 2), border_style=ctx.obj['style'].border)
+    if uuid:
+        columns = [
+            (Text('Input Name', justify='center'), 'left', ctx.obj['style'].column),
+            (Text('Kind', justify='center'), 'center', ctx.obj['style'].column),
+            (Text('Muted', justify='center'), 'center', None),
+            (Text('UUID', justify='center'), 'left', ctx.obj['style'].column),
+        ]
+    else:
+        columns = [
+            (Text('Input Name', justify='center'), 'left', ctx.obj['style'].column),
+            (Text('Kind', justify='center'), 'center', ctx.obj['style'].column),
+            (Text('Muted', justify='center'), 'center', None),
+        ]
+    for heading, justify, style in columns:
+        table.add_column(heading, justify=justify, style=style)
+
+    for input_name, input_kind, input_uuid in inputs:
+        input_mark = ''
+        try:
+            input_muted = ctx.obj['obsws'].get_input_mute(name=input_name).input_muted
+            input_mark = util.check_mark(input_muted)
+        except obsws.error.OBSSDKRequestError as e:
+            if e.code == 604:  # Input does not support audio
+                input_mark = 'N/A'
+            else:
+                raise
+
+        if uuid:
+            table.add_row(
+                input_name,
+                util.snakecase_to_titlecase(input_kind),
+                input_mark,
+                input_uuid,
+            )
+        else:
+            table.add_row(
+                input_name,
+                util.snakecase_to_titlecase(input_kind),
+                input_mark,
+            )
+
+    console.out.print(table)
+
+
+@app.command('list-kinds')
+@app.command('ls-k', hidden=True)
+def list_kinds(
+    ctx: typer.Context,
+):
+    """List all input kinds."""
+    resp = ctx.obj['obsws'].get_input_kind_list(False)
+    kinds = sorted(resp.input_kinds)
+
+    if not kinds:
+        console.out.print('No input kinds found.')
+        raise typer.Exit()
+
+    table = Table(
+        title='Input Kinds', padding=(0, 2), border_style=ctx.obj['style'].border
+    )
+    table.add_column(
+        Text('Input Kind', justify='center'),
+        justify='left',
+        style=ctx.obj['style'].column,
+    )
+
+    for kind in kinds:
+        table.add_row(util.snakecase_to_titlecase(kind))
+
+    console.out.print(table)
+
+
+@app.command('mute')
+@app.command('m', hidden=True)
+def mute(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Name of the input to mute.',
+            callback=validate.input_in_inputs,
+        ),
+    ],
+):
+    """Mute an input."""
+    ctx.obj['obsws'].set_input_mute(
+        name=input_name,
+        muted=True,
+    )
+
+    console.out.print(f'Input {console.highlight(ctx, input_name)} muted.')
+
+
+@app.command('unmute')
+@app.command('um', hidden=True)
+def unmute(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Name of the input to unmute.',
+            callback=validate.input_in_inputs,
+        ),
+    ],
+):
+    """Unmute an input."""
+    ctx.obj['obsws'].set_input_mute(
+        name=input_name,
+        muted=False,
+    )
+
+    console.out.print(f'Input {console.highlight(ctx, input_name)} unmuted.')
+
+
+@app.command('toggle')
+@app.command('tg', hidden=True)
+def toggle(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Name of the input to toggle.',
+            callback=validate.input_in_inputs,
+        ),
+    ],
+):
+    """Toggle an input."""
+    resp = ctx.obj['obsws'].get_input_mute(name=input_name)
+    new_state = not resp.input_muted
+
+    ctx.obj['obsws'].set_input_mute(
+        name=input_name,
+        muted=new_state,
+    )
+
+    if new_state:
+        console.out.print(
+            f'Input {console.highlight(ctx, input_name)} muted.',
+        )
+    else:
+        console.out.print(
+            f'Input {console.highlight(ctx, input_name)} unmuted.',
+        )
+
+
+@app.command('volume')
+@app.command('vol', hidden=True)
+def volume(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Name of the input to set volume for.',
+            callback=validate.input_in_inputs,
+        ),
+    ],
+    volume: Annotated[
+        float,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Volume level to set (-90 to 0).',
+            min=-90,
+            max=0,
+        ),
+    ],
+):
+    """Set the volume of an input."""
+    ctx.obj['obsws'].set_input_volume(
+        name=input_name,
+        vol_db=volume,
+    )
+
+    console.out.print(
+        f'Input {console.highlight(ctx, input_name)} volume set to {console.highlight(ctx, volume)}.',
+    )
+
+
+@app.command('show')
+@app.command('s', hidden=True)
+def show(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Name of the input to show.',
+            callback=validate.input_in_inputs,
+        ),
+    ],
+    verbose: Annotated[
+        bool, typer.Option(help='List all available input devices.')
+    ] = False,
+):
+    """Show information for an input in the current scene."""
+    input_list = ctx.obj['obsws'].get_input_list()
+    for input_ in input_list.inputs:
+        if input_['inputName'] == input_name:
+            input_kind = input_['inputKind']
+            break
+
+    for prop in ['device', 'device_id']:
+        try:
+            device_id = (
+                ctx.obj['obsws']
+                .get_input_settings(
+                    name=input_name,
+                )
+                .input_settings.get(prop)
+            )
+            if device_id:
+                break
+        except obsws.error.OBSSDKRequestError:
+            continue
+    else:
+        device_id = '(N/A)'
+
+    for device in (
+        ctx.obj['obsws']
+        .get_input_properties_list_property_items(
+            input_name=input_name,
+            prop_name=prop,
+        )
+        .property_items
+    ):
+        if device.get('itemValue') == device_id:
+            device_id = device.get('itemName')
+            break
+
+    table = Table(
+        title='Input Information', padding=(0, 2), border_style=ctx.obj['style'].border
+    )
+    columns = [
+        (Text('Input Name', justify='center'), 'left', ctx.obj['style'].column),
+        (Text('Kind', justify='center'), 'left', ctx.obj['style'].column),
+        (Text('Device', justify='center'), 'left', ctx.obj['style'].column),
+    ]
+    for heading, justify, style in columns:
+        table.add_column(heading, justify=justify, style=style)
+    table.add_row(
+        input_name,
+        util.snakecase_to_titlecase(input_kind),
+        device_id,
+    )
+
+    console.out.print(table)
+
+    if verbose:
+        resp = ctx.obj['obsws'].get_input_properties_list_property_items(
+            input_name=input_name,
+            prop_name=prop,
+        )
+        table = Table(
+            title='Devices',
+            padding=(0, 2),
+            border_style=ctx.obj['style'].border,
+        )
+        columns = [
+            (Text('Name', justify='center'), 'left', ctx.obj['style'].column),
+        ]
+        for heading, justify, style in columns:
+            table.add_column(heading, justify=justify, style=style)
+        for i, item in enumerate(resp.property_items):
+            table.add_row(
+                item.get('itemName'),
+                style='' if i % 2 == 0 else 'dim',
+            )
+
+        console.out.print(table)
+
+
+@app.command('update')
+@app.command('upd', hidden=True)
+def update(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Name of the input to update.',
+            callback=validate.input_in_inputs,
+        ),
+    ],
+    device_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Name of the device to set for the input.',
+        ),
+    ],
+):
+    """Update a setting for an input."""
+    device_id = None
+    for prop in ['device', 'device_id']:
+        try:
+            for device in (
+                ctx.obj['obsws']
+                .get_input_properties_list_property_items(
+                    input_name=input_name,
+                    prop_name=prop,
+                )
+                .property_items
+            ):
+                if device.get('itemName') == device_name:
+                    device_id = device.get('itemValue')
+                    break
+        except obsws.error.OBSSDKRequestError:
+            continue
+        if device_id:
+            break
+
+    if not device_id:
+        console.err.print(
+            f'Failed to find device ID for device '
+            f'{console.highlight(ctx, device_name)}.',
+        )
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].set_input_settings(
+        name=input_name, settings={prop: device_id}, overlay=True
+    )
+
+    console.out.print(
+        f'Input {console.highlight(ctx, input_name)} updated to use device '
+        f'{console.highlight(ctx, device_name)}.',
+    )

obsws_cli/commands/media.py

@@ -0,0 +1,105 @@
+"""module containing commands for media inputs."""
+
+from typing import Annotated, Optional
+
+import typer
+
+from obsws_cli import console, util, validate
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Commands for media inputs."""
+
+
+@app.command('cursor')
+@app.command('cur', hidden=True)
+def cursor(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str, typer.Argument(..., help='The name of the media input.')
+    ],
+    timecode: Annotated[
+        Optional[str],
+        typer.Argument(
+            ...,
+            help='The timecode to set the cursor to (format: HH:MM:SS).',
+            callback=validate.timecode_format,
+        ),
+    ] = None,
+):
+    """Get/set the cursor position of a media input."""
+    if timecode is None:
+        resp = ctx.obj['obsws'].get_media_input_status(input_name)
+        console.out.print(
+            f'Cursor for {console.highlight(ctx, input_name)} is at {util.milliseconds_to_timecode(resp.media_cursor)}.'
+        )
+        return
+
+    cursor_position = util.timecode_to_milliseconds(timecode)
+    ctx.obj['obsws'].set_media_input_cursor(input_name, cursor_position)
+    console.out.print(
+        f'Cursor for {console.highlight(ctx, input_name)} set to {timecode}.'
+    )
+
+
+@app.command('play')
+@app.command('p', hidden=True)
+def play(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str, typer.Argument(..., help='The name of the media input.')
+    ],
+):
+    """Get/set the playing status of a media input."""
+    ctx.obj['obsws'].trigger_media_input_action(
+        input_name, 'OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY'
+    )
+    console.out.print(f'Playing media input {console.highlight(ctx, input_name)}.')
+
+
+@app.command('pause')
+@app.command('pa', hidden=True)
+def pause(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str, typer.Argument(..., help='The name of the media input.')
+    ],
+):
+    """Pause a media input."""
+    ctx.obj['obsws'].trigger_media_input_action(
+        input_name, 'OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PAUSE'
+    )
+    console.out.print(f'Paused media input {console.highlight(ctx, input_name)}.')
+
+
+@app.command('stop')
+@app.command('s', hidden=True)
+def stop(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str, typer.Argument(..., help='The name of the media input.')
+    ],
+):
+    """Stop a media input."""
+    ctx.obj['obsws'].trigger_media_input_action(
+        input_name, 'OBS_WEBSOCKET_MEDIA_INPUT_ACTION_STOP'
+    )
+    console.out.print(f'Stopped media input {console.highlight(ctx, input_name)}.')
+
+
+@app.command('restart')
+@app.command('r', hidden=True)
+def restart(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str, typer.Argument(..., help='The name of the media input.')
+    ],
+):
+    """Restart a media input."""
+    ctx.obj['obsws'].trigger_media_input_action(
+        input_name, 'OBS_WEBSOCKET_MEDIA_INPUT_ACTION_RESTART'
+    )
+    console.out.print(f'Restarted media input {console.highlight(ctx, input_name)}.')

obsws_cli/commands/profile.py

@@ -0,0 +1,121 @@
+"""module containing commands for manipulating profiles in OBS."""
+
+from typing import Annotated
+
+import typer
+from rich.table import Table
+from rich.text import Text
+
+from obsws_cli import console, util, validate
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Control profiles in OBS."""
+
+
+@app.command('list')
+@app.command('ls', hidden=True)
+def list_(ctx: typer.Context):
+    """List profiles."""
+    resp = ctx.obj['obsws'].get_profile_list()
+
+    if not resp.profiles:
+        console.out.print('No profiles found.')
+        raise typer.Exit()
+
+    table = Table(
+        title='Profiles', padding=(0, 2), border_style=ctx.obj['style'].border
+    )
+    columns = [
+        (Text('Profile Name', justify='center'), 'left', ctx.obj['style'].column),
+        (Text('Current', justify='center'), 'center', None),
+    ]
+    for heading, justify, style in columns:
+        table.add_column(heading, justify=justify, style=style)
+
+    for profile in resp.profiles:
+        table.add_row(
+            profile,
+            util.check_mark(
+                ctx, profile == resp.current_profile_name, empty_if_false=True
+            ),
+        )
+
+    console.out.print(table)
+
+
+@app.command('current')
+@app.command('get', hidden=True)
+def current(ctx: typer.Context):
+    """Get the current profile."""
+    resp = ctx.obj['obsws'].get_profile_list()
+    console.out.print(
+        f'Current profile: {console.highlight(ctx, resp.current_profile_name)}'
+    )
+
+
+@app.command('switch')
+@app.command('set', hidden=True)
+def switch(
+    ctx: typer.Context,
+    profile_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Name of the profile to switch to',
+            callback=validate.profile_exists,
+        ),
+    ],
+):
+    """Switch to a profile."""
+    resp = ctx.obj['obsws'].get_profile_list()
+    if resp.current_profile_name == profile_name:
+        console.err.print(
+            f'Profile [yellow]{profile_name}[/yellow] is already the current profile.'
+        )
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].set_current_profile(profile_name)
+    console.out.print(f'Switched to profile {console.highlight(ctx, profile_name)}.')
+
+
+@app.command('create')
+@app.command('new', hidden=True)
+def create(
+    ctx: typer.Context,
+    profile_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Name of the profile to create.',
+            callback=validate.profile_not_exists,
+        ),
+    ],
+):
+    """Create a new profile."""
+    ctx.obj['obsws'].create_profile(profile_name)
+    console.out.print(f'Created profile {console.highlight(ctx, profile_name)}.')
+
+
+@app.command('remove')
+@app.command('rm', hidden=True)
+def remove(
+    ctx: typer.Context,
+    profile_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Name of the profile to remove.',
+            callback=validate.profile_exists,
+        ),
+    ],
+):
+    """Remove a profile."""
+    ctx.obj['obsws'].remove_profile(profile_name)
+    console.out.print(f'Removed profile {console.highlight(ctx, profile_name)}.')

obsws_cli/commands/projector.py

@@ -0,0 +1,89 @@
+"""module containing commands for manipulating projectors in OBS."""
+
+from typing import Annotated
+
+import typer
+from rich.table import Table
+from rich.text import Text
+
+from obsws_cli import console
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Control projectors in OBS."""
+
+
+@app.command('list-monitors')
+@app.command('ls-m', hidden=True)
+def list_monitors(ctx: typer.Context):
+    """List available monitors."""
+    resp = ctx.obj['obsws'].get_monitor_list()
+    monitors = sorted(
+        ((m['monitorIndex'], m['monitorName']) for m in resp.monitors),
+        key=lambda m: m[0],
+    )
+
+    if not monitors:
+        console.out.print('No monitors found.')
+        raise typer.Exit()
+
+    table = Table(
+        title='Available Monitors',
+        padding=(0, 2),
+        border_style=ctx.obj['style'].border,
+    )
+    table.add_column(
+        Text('Index', justify='center'), justify='center', style=ctx.obj['style'].column
+    )
+    table.add_column(
+        Text('Name', justify='center'), justify='left', style=ctx.obj['style'].column
+    )
+
+    for index, monitor in monitors:
+        table.add_row(str(index), monitor)
+
+    console.out.print(table)
+
+
+@app.command('open')
+@app.command('o', hidden=True)
+def open(
+    ctx: typer.Context,
+    monitor_index: Annotated[
+        int,
+        typer.Option(help='Index of the monitor to open the projector on.'),
+    ] = 0,
+    source_name: Annotated[
+        str,
+        typer.Argument(
+            show_default='The current scene',
+            help='Name of the source to project.',
+        ),
+    ] = '',
+):
+    """Open a fullscreen projector for a source on a specific monitor."""
+    if not source_name:
+        source_name = ctx.obj['obsws'].get_current_program_scene().scene_name
+
+    monitors = ctx.obj['obsws'].get_monitor_list().monitors
+    for monitor in monitors:
+        if monitor['monitorIndex'] == monitor_index:
+            ctx.obj['obsws'].open_source_projector(
+                source_name=source_name,
+                monitor_index=monitor_index,
+            )
+
+            console.out.print(
+                f'Opened projector for source {console.highlight(ctx, source_name)} on monitor {console.highlight(ctx, monitor["monitorName"])}.'
+            )
+
+            break
+    else:
+        console.err.print(
+            f'Monitor with index [yellow]{monitor_index}[/yellow] not found. '
+            f'Use [yellow]obsws-cli projector ls-m[/yellow] to see available monitors.'
+        )
+        raise typer.Exit(code=1)

obsws_cli/commands/record.py

@@ -0,0 +1,180 @@
+"""module for controlling OBS recording functionality."""
+
+from pathlib import Path
+from typing import Annotated, Optional
+
+import typer
+
+from obsws_cli import console
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Control OBS recording functionality."""
+
+
+def _get_recording_status(ctx: typer.Context) -> tuple:
+    """Get recording status."""
+    resp = ctx.obj['obsws'].get_record_status()
+    return resp.output_active, resp.output_paused
+
+
+@app.command('start')
+@app.command('s', hidden=True)
+def start(ctx: typer.Context):
+    """Start recording."""
+    active, paused = _get_recording_status(ctx)
+    if active:
+        err_msg = 'Recording is already in progress, cannot start.'
+        if paused:
+            err_msg += ' Try resuming it.'
+
+        console.err.print(err_msg)
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].start_record()
+    console.out.print('Recording started successfully.')
+
+
+@app.command('stop')
+@app.command('st', hidden=True)
+def stop(ctx: typer.Context):
+    """Stop recording."""
+    active, _ = _get_recording_status(ctx)
+    if not active:
+        console.err.print('Recording is not in progress, cannot stop.')
+        raise typer.Exit(1)
+
+    resp = ctx.obj['obsws'].stop_record()
+    console.out.print(
+        f'Recording stopped successfully. Saved to: {console.highlight(ctx, resp.output_path)}'
+    )
+
+
+@app.command('toggle')
+@app.command('tg', hidden=True)
+def toggle(ctx: typer.Context):
+    """Toggle recording."""
+    resp = ctx.obj['obsws'].toggle_record()
+    if resp.output_active:
+        console.out.print('Recording started successfully.')
+    else:
+        console.out.print('Recording stopped successfully.')
+
+
+@app.command('status')
+@app.command('ss', hidden=True)
+def status(ctx: typer.Context):
+    """Get recording status."""
+    active, paused = _get_recording_status(ctx)
+    if active:
+        if paused:
+            console.out.print('Recording is in progress and paused.')
+        else:
+            console.out.print('Recording is in progress.')
+    else:
+        console.out.print('Recording is not in progress.')
+
+
+@app.command('resume')
+@app.command('r', hidden=True)
+def resume(ctx: typer.Context):
+    """Resume recording."""
+    active, paused = _get_recording_status(ctx)
+    if not active:
+        console.err.print('Recording is not in progress, cannot resume.')
+        raise typer.Exit(1)
+    if not paused:
+        console.err.print('Recording is in progress but not paused, cannot resume.')
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].resume_record()
+    console.out.print('Recording resumed successfully.')
+
+
+@app.command('pause')
+@app.command('p', hidden=True)
+def pause(ctx: typer.Context):
+    """Pause recording."""
+    active, paused = _get_recording_status(ctx)
+    if not active:
+        console.err.print('Recording is not in progress, cannot pause.')
+        raise typer.Exit(1)
+    if paused:
+        console.err.print('Recording is in progress but already paused, cannot pause.')
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].pause_record()
+    console.out.print('Recording paused successfully.')
+
+
+@app.command('directory')
+@app.command('d', hidden=True)
+def directory(
+    ctx: typer.Context,
+    record_directory: Annotated[
+        Optional[Path],
+        # Since the CLI and OBS may be running on different platforms,
+        # we won't validate the path here.
+        typer.Argument(
+            file_okay=False,
+            dir_okay=True,
+            help='Directory to set for recording.',
+        ),
+    ] = None,
+):
+    """Get or set the recording directory."""
+    if record_directory is not None:
+        ctx.obj['obsws'].set_record_directory(str(record_directory))
+        console.out.print(
+            f'Recording directory updated to: {console.highlight(ctx, record_directory)}'
+        )
+    else:
+        resp = ctx.obj['obsws'].get_record_directory()
+        console.out.print(
+            f'Recording directory: {console.highlight(ctx, resp.record_directory)}'
+        )
+
+
+@app.command('split')
+@app.command('sp', hidden=True)
+def split(ctx: typer.Context):
+    """Split the current recording."""
+    active, paused = _get_recording_status(ctx)
+    if not active:
+        console.err.print('Recording is not in progress, cannot split.')
+        raise typer.Exit(1)
+    if paused:
+        console.err.print('Recording is paused, cannot split.')
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].split_record_file()
+    console.out.print('Recording split successfully.')
+
+
+@app.command('chapter')
+@app.command('ch', hidden=True)
+def chapter(
+    ctx: typer.Context,
+    chapter_name: Annotated[
+        Optional[str],
+        typer.Argument(
+            help='Name of the chapter to create.',
+        ),
+    ] = None,
+):
+    """Create a chapter in the current recording."""
+    active, paused = _get_recording_status(ctx)
+    if not active:
+        console.err.print('Recording is not in progress, cannot create chapter.')
+        raise typer.Exit(1)
+    if paused:
+        console.err.print('Recording is paused, cannot create chapter.')
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].create_record_chapter(chapter_name)
+    console.out.print(
+        f'Chapter {console.highlight(ctx, chapter_name or "unnamed")} created successfully.'
+    )

obsws_cli/commands/replaybuffer.py

@@ -0,0 +1,68 @@
+"""module containing commands for manipulating the replay buffer in OBS."""
+
+import typer
+
+from obsws_cli import console
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Control the replay buffer in OBS."""
+
+
+@app.command('start')
+@app.command('s', hidden=True)
+def start(ctx: typer.Context):
+    """Start the replay buffer."""
+    resp = ctx.obj['obsws'].get_replay_buffer_status()
+    if resp.output_active:
+        console.err.print('Replay buffer is already active.')
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].start_replay_buffer()
+    console.out.print('Replay buffer started.')
+
+
+@app.command('stop')
+@app.command('st', hidden=True)
+def stop(ctx: typer.Context):
+    """Stop the replay buffer."""
+    resp = ctx.obj['obsws'].get_replay_buffer_status()
+    if not resp.output_active:
+        console.err.print('Replay buffer is not active.')
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].stop_replay_buffer()
+    console.out.print('Replay buffer stopped.')
+
+
+@app.command('toggle')
+@app.command('tg', hidden=True)
+def toggle(ctx: typer.Context):
+    """Toggle the replay buffer."""
+    resp = ctx.obj['obsws'].toggle_replay_buffer()
+    if resp.output_active:
+        console.out.print('Replay buffer is active.')
+    else:
+        console.out.print('Replay buffer is not active.')
+
+
+@app.command('status')
+@app.command('ss', hidden=True)
+def status(ctx: typer.Context):
+    """Get the status of the replay buffer."""
+    resp = ctx.obj['obsws'].get_replay_buffer_status()
+    if resp.output_active:
+        console.out.print('Replay buffer is active.')
+    else:
+        console.out.print('Replay buffer is not active.')
+
+
+@app.command('save')
+@app.command('sv', hidden=True)
+def save(ctx: typer.Context):
+    """Save the replay buffer."""
+    ctx.obj['obsws'].save_replay_buffer()
+    console.out.print('Replay buffer saved.')

obsws_cli/commands/scene.py

@@ -0,0 +1,124 @@
+"""module containing commands for controlling OBS scenes."""
+
+from typing import Annotated
+
+import typer
+from rich.table import Table
+from rich.text import Text
+
+from obsws_cli import console, util, validate
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Control OBS scenes."""
+
+
+@app.command('list')
+@app.command('ls', hidden=True)
+def list_(
+    ctx: typer.Context,
+    uuid: Annotated[bool, typer.Option(help='Show UUIDs of scenes')] = False,
+):
+    """List all scenes."""
+    resp = ctx.obj['obsws'].get_scene_list()
+    scenes = (
+        (scene.get('sceneName'), scene.get('sceneUuid'))
+        for scene in reversed(resp.scenes)
+    )
+
+    if not scenes:
+        console.out.print('No scenes found.')
+        raise typer.Exit()
+
+    active_scene = ctx.obj['obsws'].get_current_program_scene().scene_name
+
+    table = Table(title='Scenes', padding=(0, 2), border_style=ctx.obj['style'].border)
+    if uuid:
+        columns = [
+            (Text('Scene Name', justify='center'), 'left', ctx.obj['style'].column),
+            (Text('Active', justify='center'), 'center', None),
+            (Text('UUID', justify='center'), 'left', ctx.obj['style'].column),
+        ]
+    else:
+        columns = [
+            (Text('Scene Name', justify='center'), 'left', ctx.obj['style'].column),
+            (Text('Active', justify='center'), 'center', None),
+        ]
+    for heading, justify, style in columns:
+        table.add_column(heading, justify=justify, style=style)
+
+    for scene_name, scene_uuid in scenes:
+        if uuid:
+            table.add_row(
+                scene_name,
+                util.check_mark(scene_name == active_scene, empty_if_false=True),
+                scene_uuid,
+            )
+        else:
+            table.add_row(
+                scene_name,
+                util.check_mark(scene_name == active_scene, empty_if_false=True),
+            )
+
+    console.out.print(table)
+
+
+@app.command('current')
+@app.command('get', hidden=True)
+def current(
+    ctx: typer.Context,
+    preview: Annotated[
+        bool,
+        typer.Option(
+            help='Get the preview scene instead of the program scene',
+            callback=validate.studio_mode_enabled,
+        ),
+    ] = False,
+):
+    """Get the current program scene or preview scene."""
+    if preview:
+        resp = ctx.obj['obsws'].get_current_preview_scene()
+        console.out.print(
+            f'Current Preview Scene: {console.highlight(ctx, resp.current_preview_scene_name)}'
+        )
+    else:
+        resp = ctx.obj['obsws'].get_current_program_scene()
+        console.out.print(
+            f'Current Program Scene: {console.highlight(ctx, resp.current_program_scene_name)}'
+        )
+
+
+@app.command('switch')
+@app.command('set', hidden=True)
+def switch(
+    ctx: typer.Context,
+    scene_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            help='Name of the scene to switch to',
+            callback=validate.scene_in_scenes,
+        ),
+    ],
+    preview: Annotated[
+        bool,
+        typer.Option(
+            help='Switch to the preview scene instead of the program scene',
+            callback=validate.studio_mode_enabled,
+        ),
+    ] = False,
+):
+    """Switch to a scene."""
+    if preview:
+        ctx.obj['obsws'].set_current_preview_scene(scene_name)
+        console.out.print(
+            f'Switched to preview scene: {console.highlight(ctx, scene_name)}'
+        )
+    else:
+        ctx.obj['obsws'].set_current_program_scene(scene_name)
+        console.out.print(
+            f'Switched to program scene: {console.highlight(ctx, scene_name)}'
+        )

obsws_cli/commands/scenecollection.py

@@ -0,0 +1,99 @@
+"""module containing commands for manipulating scene collections."""
+
+from typing import Annotated
+
+import typer
+from rich.table import Table
+
+from obsws_cli import console, validate
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Control scene collections in OBS."""
+
+
+@app.command('list')
+@app.command('ls', hidden=True)
+def list_(ctx: typer.Context):
+    """List all scene collections."""
+    resp = ctx.obj['obsws'].get_scene_collection_list()
+
+    if not resp.scene_collections:
+        console.out.print('No scene collections found.')
+        raise typer.Exit()
+
+    table = Table(
+        title='Scene Collections',
+        padding=(0, 2),
+        border_style=ctx.obj['style'].border,
+    )
+    table.add_column(
+        'Scene Collection Name', justify='left', style=ctx.obj['style'].column
+    )
+
+    for scene_collection_name in resp.scene_collections:
+        table.add_row(scene_collection_name)
+
+    console.out.print(table)
+
+
+@app.command('current')
+@app.command('get', hidden=True)
+def current(ctx: typer.Context):
+    """Get the current scene collection."""
+    resp = ctx.obj['obsws'].get_scene_collection_list()
+    console.out.print(
+        f'Current scene collection: {console.highlight(ctx, resp.current_scene_collection_name)}'
+    )
+
+
+@app.command('switch')
+@app.command('set', hidden=True)
+def switch(
+    ctx: typer.Context,
+    scene_collection_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            help='Name of the scene collection to switch to',
+            callback=validate.scene_collection_in_scene_collections,
+        ),
+    ],
+):
+    """Switch to a scene collection."""
+    current_scene_collection = (
+        ctx.obj['obsws'].get_scene_collection_list().current_scene_collection_name
+    )
+    if scene_collection_name == current_scene_collection:
+        console.err.print(
+            f'Scene collection [yellow]{scene_collection_name}[/yellow] is already active.'
+        )
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].set_current_scene_collection(scene_collection_name)
+    console.out.print(
+        f'Switched to scene collection {console.highlight(ctx, scene_collection_name)}.'
+    )
+
+
+@app.command('create')
+@app.command('new', hidden=True)
+def create(
+    ctx: typer.Context,
+    scene_collection_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            help='Name of the scene collection to create',
+            callback=validate.scene_collection_not_in_scene_collections,
+        ),
+    ],
+):
+    """Create a new scene collection."""
+    ctx.obj['obsws'].create_scene_collection(scene_collection_name)
+    console.out.print(
+        f'Created scene collection {console.highlight(ctx, scene_collection_name)}.'
+    )

obsws_cli/commands/sceneitem.py

@@ -0,0 +1,504 @@
+"""module containing commands for manipulating items in scenes."""
+
+from typing import Annotated, Optional
+
+import typer
+from rich.table import Table
+
+from obsws_cli import console, util, validate
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Control items in OBS scenes."""
+
+
+@app.command('list')
+@app.command('ls', hidden=True)
+def list_(
+    ctx: typer.Context,
+    scene_name: Annotated[
+        Optional[str],
+        typer.Argument(
+            show_default='The current scene',
+            help='Scene name to list items for',
+            callback=validate.scene_in_scenes,
+        ),
+    ] = None,
+    uuid: Annotated[bool, typer.Option(help='Show UUIDs of scene items')] = False,
+):
+    """List all items in a scene."""
+    if scene_name is None:
+        scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
+
+    resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
+    items = sorted(
+        (
+            (
+                item.get('sceneItemId'),
+                item.get('sourceName'),
+                item.get('isGroup'),
+                item.get('sceneItemEnabled'),
+                item.get('sourceUuid', 'N/A'),  # Include source UUID
+            )
+            for item in resp.scene_items
+        ),
+        key=lambda x: x[0],  # Sort by sceneItemId
+    )
+
+    if not items:
+        console.out.print(
+            f'No items found in scene {console.highlight(ctx, scene_name)}.'
+        )
+        raise typer.Exit()
+
+    table = Table(
+        title=f'Items in Scene: {scene_name}',
+        padding=(0, 2),
+        border_style=ctx.obj['style'].border,
+    )
+    if uuid:
+        columns = [
+            ('Item ID', 'center', ctx.obj['style'].column),
+            ('Item Name', 'left', ctx.obj['style'].column),
+            ('In Group', 'left', ctx.obj['style'].column),
+            ('Enabled', 'center', None),
+            ('UUID', 'left', ctx.obj['style'].column),
+        ]
+    else:
+        columns = [
+            ('Item ID', 'center', ctx.obj['style'].column),
+            ('Item Name', 'left', ctx.obj['style'].column),
+            ('In Group', 'left', ctx.obj['style'].column),
+            ('Enabled', 'center', None),
+        ]
+    # Add columns to the table
+    for heading, justify, style in columns:
+        table.add_column(heading, justify=justify, style=style)
+
+    for item_id, item_name, is_group, is_enabled, source_uuid in items:
+        if is_group:
+            resp = ctx.obj['obsws'].get_group_scene_item_list(item_name)
+            group_items = sorted(
+                (
+                    (
+                        gi.get('sceneItemId'),
+                        gi.get('sourceName'),
+                        gi.get('sceneItemEnabled'),
+                        gi.get('sourceUuid', 'N/A'),  # Include source UUID
+                    )
+                    for gi in resp.scene_items
+                ),
+                key=lambda x: x[0],  # Sort by sceneItemId
+            )
+            for (
+                group_item_id,
+                group_item_name,
+                group_item_enabled,
+                group_item_source_uuid,
+            ) in group_items:
+                if uuid:
+                    table.add_row(
+                        str(group_item_id),
+                        group_item_name,
+                        item_name,
+                        util.check_mark(is_enabled and group_item_enabled),
+                        group_item_source_uuid,
+                    )
+                else:
+                    table.add_row(
+                        str(group_item_id),
+                        group_item_name,
+                        item_name,
+                        util.check_mark(is_enabled and group_item_enabled),
+                    )
+        else:
+            if uuid:
+                table.add_row(
+                    str(item_id),
+                    item_name,
+                    '',
+                    util.check_mark(is_enabled),
+                    source_uuid,
+                )
+            else:
+                table.add_row(
+                    str(item_id),
+                    item_name,
+                    '',
+                    util.check_mark(is_enabled),
+                )
+
+    console.out.print(table)
+
+
+def _validate_sources(
+    ctx: typer.Context,
+    scene_name: str,
+    item_name: str,
+    group: Optional[str] = None,
+) -> bool:
+    """Validate the scene name and item name."""
+    if not validate.scene_in_scenes(ctx, scene_name):
+        console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
+        return False
+
+    if group:
+        if not validate.item_in_scene_item_list(ctx, scene_name, group):
+            console.err.print(
+                f'Group [yellow]{group}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
+            )
+            return False
+    else:
+        if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
+            console.err.print(
+                f'Item [yellow]{item_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow]. Is the item in a group? '
+                f'If so use the [yellow]--group[/yellow] option to specify the parent group.\n'
+                'Use [yellow]obsws-cli sceneitem ls[/yellow] for a list of items in the scene.'
+            )
+            return False
+
+    return True
+
+
+def _get_scene_name_and_item_id(
+    ctx: typer.Context, scene_name: str, item_name: str, group: Optional[str] = None
+):
+    """Get the scene name and item ID for the given scene and item name."""
+    if group:
+        resp = ctx.obj['obsws'].get_group_scene_item_list(group)
+        for item in resp.scene_items:
+            if item.get('sourceName') == item_name:
+                scene_name = group
+                scene_item_id = item.get('sceneItemId')
+                break
+        else:
+            console.err.print(
+                f'Item [yellow]{item_name}[/yellow] not found in group [yellow]{group}[/yellow].'
+            )
+            raise typer.Exit(1)
+    else:
+        resp = ctx.obj['obsws'].get_scene_item_id(scene_name, item_name)
+        scene_item_id = resp.scene_item_id
+
+    return scene_name, scene_item_id
+
+
+@app.command('show')
+@app.command('sh', hidden=True)
+def show(
+    ctx: typer.Context,
+    scene_name: Annotated[
+        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
+    ],
+    item_name: Annotated[
+        str,
+        typer.Argument(..., show_default=False, help='Item name to show in the scene'),
+    ],
+    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
+):
+    """Show an item in a scene."""
+    if not _validate_sources(ctx, scene_name, item_name, group):
+        raise typer.Exit(1)
+
+    old_scene_name = scene_name
+    scene_name, scene_item_id = _get_scene_name_and_item_id(
+        ctx, scene_name, item_name, group
+    )
+
+    ctx.obj['obsws'].set_scene_item_enabled(
+        scene_name=scene_name,
+        item_id=int(scene_item_id),
+        enabled=True,
+    )
+
+    if group:
+        console.out.print(
+            f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
+            f'in scene {console.highlight(ctx, old_scene_name)} has been shown.'
+        )
+    else:
+        # If not in a parent group, just show the scene name
+        # This is to avoid confusion with the parent group name
+        # which is not the same as the scene name
+        # and is not needed in this case
+        console.out.print(
+            f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been shown.'
+        )
+
+
+@app.command('hide')
+@app.command('h', hidden=True)
+def hide(
+    ctx: typer.Context,
+    scene_name: Annotated[
+        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
+    ],
+    item_name: Annotated[
+        str,
+        typer.Argument(..., show_default=False, help='Item name to hide in the scene'),
+    ],
+    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
+):
+    """Hide an item in a scene."""
+    if not _validate_sources(ctx, scene_name, item_name, group):
+        raise typer.Exit(1)
+
+    old_scene_name = scene_name
+    scene_name, scene_item_id = _get_scene_name_and_item_id(
+        ctx, scene_name, item_name, group
+    )
+
+    ctx.obj['obsws'].set_scene_item_enabled(
+        scene_name=scene_name,
+        item_id=int(scene_item_id),
+        enabled=False,
+    )
+
+    if group:
+        console.out.print(
+            f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} in scene {console.highlight(ctx, old_scene_name)} has been hidden.'
+        )
+    else:
+        # If not in a parent group, just show the scene name
+        # This is to avoid confusion with the parent group name
+        # which is not the same as the scene name
+        # and is not needed in this case
+        console.out.print(
+            f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been hidden.'
+        )
+
+
+@app.command('toggle')
+@app.command('tg', hidden=True)
+def toggle(
+    ctx: typer.Context,
+    scene_name: Annotated[
+        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
+    ],
+    item_name: Annotated[
+        str,
+        typer.Argument(
+            ..., show_default=False, help='Item name to toggle in the scene'
+        ),
+    ],
+    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
+):
+    """Toggle an item in a scene."""
+    if not _validate_sources(ctx, scene_name, item_name, group):
+        raise typer.Exit(1)
+
+    old_scene_name = scene_name
+    scene_name, scene_item_id = _get_scene_name_and_item_id(
+        ctx, scene_name, item_name, group
+    )
+
+    enabled = ctx.obj['obsws'].get_scene_item_enabled(
+        scene_name=scene_name,
+        item_id=int(scene_item_id),
+    )
+    new_state = not enabled.scene_item_enabled
+
+    ctx.obj['obsws'].set_scene_item_enabled(
+        scene_name=scene_name,
+        item_id=int(scene_item_id),
+        enabled=new_state,
+    )
+
+    if group:
+        if new_state:
+            console.out.print(
+                f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
+                f'in scene {console.highlight(ctx, old_scene_name)} has been shown.'
+            )
+        else:
+            console.out.print(
+                f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
+                f'in scene {console.highlight(ctx, old_scene_name)} has been hidden.'
+            )
+    else:
+        # If not in a parent group, just show the scene name
+        # This is to avoid confusion with the parent group name
+        # which is not the same as the scene name
+        # and is not needed in this case
+        if new_state:
+            console.out.print(
+                f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been shown.'
+            )
+        else:
+            console.out.print(
+                f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been hidden.'
+            )
+
+
+@app.command('visible')
+@app.command('v', hidden=True)
+def visible(
+    ctx: typer.Context,
+    scene_name: Annotated[
+        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
+    ],
+    item_name: Annotated[
+        str,
+        typer.Argument(
+            ..., show_default=False, help='Item name to check visibility in the scene'
+        ),
+    ],
+    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
+):
+    """Check if an item in a scene is visible."""
+    if not _validate_sources(ctx, scene_name, item_name, group):
+        raise typer.Exit(1)
+
+    old_scene_name = scene_name
+    scene_name, scene_item_id = _get_scene_name_and_item_id(
+        ctx, scene_name, item_name, group
+    )
+
+    enabled = ctx.obj['obsws'].get_scene_item_enabled(
+        scene_name=scene_name,
+        item_id=int(scene_item_id),
+    )
+
+    if group:
+        console.out.print(
+            f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
+            f'in scene {console.highlight(ctx, old_scene_name)} is currently {"visible" if enabled.scene_item_enabled else "hidden"}.'
+        )
+    else:
+        # If not in a parent group, just show the scene name
+        # This is to avoid confusion with the parent group name
+        # which is not the same as the scene name
+        # and is not needed in this case
+        console.out.print(
+            f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} '
+            f'is currently {"visible" if enabled.scene_item_enabled else "hidden"}.'
+        )
+
+
+@app.command('transform')
+@app.command('t', hidden=True)
+def transform(
+    ctx: typer.Context,
+    scene_name: Annotated[
+        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
+    ],
+    item_name: Annotated[
+        str,
+        typer.Argument(
+            ..., show_default=False, help='Item name to transform in the scene'
+        ),
+    ],
+    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
+    alignment: Annotated[
+        Optional[int], typer.Option(help='Alignment of the item in the scene')
+    ] = None,
+    bounds_alignment: Annotated[
+        Optional[int], typer.Option(help='Bounds alignment of the item in the scene')
+    ] = None,
+    bounds_height: Annotated[
+        Optional[float], typer.Option(help='Height of the item in the scene')
+    ] = None,
+    bounds_type: Annotated[
+        Optional[str], typer.Option(help='Type of bounds for the item in the scene')
+    ] = None,
+    bounds_width: Annotated[
+        Optional[float], typer.Option(help='Width of the item in the scene')
+    ] = None,
+    crop_to_bounds: Annotated[
+        Optional[bool], typer.Option(help='Crop the item to the bounds')
+    ] = None,
+    crop_bottom: Annotated[
+        Optional[float], typer.Option(help='Bottom crop of the item in the scene')
+    ] = None,
+    crop_left: Annotated[
+        Optional[float], typer.Option(help='Left crop of the item in the scene')
+    ] = None,
+    crop_right: Annotated[
+        Optional[float], typer.Option(help='Right crop of the item in the scene')
+    ] = None,
+    crop_top: Annotated[
+        Optional[float], typer.Option(help='Top crop of the item in the scene')
+    ] = None,
+    position_x: Annotated[
+        Optional[float], typer.Option(help='X position of the item in the scene')
+    ] = None,
+    position_y: Annotated[
+        Optional[float], typer.Option(help='Y position of the item in the scene')
+    ] = None,
+    rotation: Annotated[
+        Optional[float], typer.Option(help='Rotation of the item in the scene')
+    ] = None,
+    scale_x: Annotated[
+        Optional[float], typer.Option(help='X scale of the item in the scene')
+    ] = None,
+    scale_y: Annotated[
+        Optional[float], typer.Option(help='Y scale of the item in the scene')
+    ] = None,
+):
+    """Set the transform of an item in a scene."""
+    if not _validate_sources(ctx, scene_name, item_name, group):
+        raise typer.Exit(1)
+
+    old_scene_name = scene_name
+    scene_name, scene_item_id = _get_scene_name_and_item_id(
+        ctx, scene_name, item_name, group
+    )
+
+    transform = {}
+    if alignment is not None:
+        transform['alignment'] = alignment
+    if bounds_alignment is not None:
+        transform['boundsAlignment'] = bounds_alignment
+    if bounds_height is not None:
+        transform['boundsHeight'] = bounds_height
+    if bounds_type is not None:
+        transform['boundsType'] = bounds_type
+    if bounds_width is not None:
+        transform['boundsWidth'] = bounds_width
+    if crop_to_bounds is not None:
+        transform['cropToBounds'] = crop_to_bounds
+    if crop_bottom is not None:
+        transform['cropBottom'] = crop_bottom
+    if crop_left is not None:
+        transform['cropLeft'] = crop_left
+    if crop_right is not None:
+        transform['cropRight'] = crop_right
+    if crop_top is not None:
+        transform['cropTop'] = crop_top
+    if position_x is not None:
+        transform['positionX'] = position_x
+    if position_y is not None:
+        transform['positionY'] = position_y
+    if rotation is not None:
+        transform['rotation'] = rotation
+    if scale_x is not None:
+        transform['scaleX'] = scale_x
+    if scale_y is not None:
+        transform['scaleY'] = scale_y
+
+    if not transform:
+        console.err.print('No transform options provided.')
+        raise typer.Exit(1)
+
+    transform = ctx.obj['obsws'].set_scene_item_transform(
+        scene_name=scene_name,
+        item_id=int(scene_item_id),
+        transform=transform,
+    )
+
+    if group:
+        console.out.print(
+            f'Item {console.highlight(ctx, item_name)} in group {console.highlight(ctx, group)} '
+            f'in scene {console.highlight(ctx, old_scene_name)} has been transformed.'
+        )
+    else:
+        # If not in a parent group, just show the scene name
+        # This is to avoid confusion with the parent group name
+        # which is not the same as the scene name
+        # and is not needed in this case
+        console.out.print(
+            f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been transformed.'
+        )

obsws_cli/commands/screenshot.py

@@ -0,0 +1,90 @@
+"""module for taking screenshots using OBS WebSocket API."""
+
+from pathlib import Path
+from typing import Annotated
+
+import obsws_python as obsws
+import typer
+
+from obsws_cli import console
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Take screenshots using OBS."""
+
+
+@app.command('save')
+@app.command('s', hidden=True)
+def save(
+    ctx: typer.Context,
+    source_name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            show_default=False,
+            help='Name of the source to take a screenshot of.',
+        ),
+    ],
+    output_path: Annotated[
+        Path,
+        # Since the CLI and OBS may be running on different platforms,
+        # we won't validate the path here.
+        typer.Argument(
+            ...,
+            show_default=False,
+            file_okay=True,
+            dir_okay=False,
+            help='Path to save the screenshot (must include file name and extension).',
+        ),
+    ],
+    width: Annotated[
+        float,
+        typer.Option(
+            help='Width of the screenshot.',
+        ),
+    ] = 1920,
+    height: Annotated[
+        float,
+        typer.Option(
+            help='Height of the screenshot.',
+        ),
+    ] = 1080,
+    quality: Annotated[
+        float,
+        typer.Option(
+            min=-1,
+            max=100,
+            help='Quality of the screenshot.',
+        ),
+    ] = -1,
+):
+    """Take a screenshot and save it to a file."""
+    try:
+        ctx.obj['obsws'].save_source_screenshot(
+            name=source_name,
+            img_format=output_path.suffix.lstrip('.').lower(),
+            file_path=str(output_path),
+            width=width,
+            height=height,
+            quality=quality,
+        )
+    except obsws.error.OBSSDKRequestError as e:
+        match e.code:
+            case 403:
+                console.err.print(
+                    'The [yellow]image format[/yellow] (file extension) must be included in the file name, '
+                    "for example: '/path/to/screenshot.png'.",
+                )
+                raise typer.Exit(1)
+            case 600:
+                console.err.print(
+                    f'No source was found by the name of [yellow]{source_name}[/yellow]'
+                )
+                raise typer.Exit(1)
+            case _:
+                raise
+
+    console.out.print(f'Screenshot saved to {console.highlight(ctx, output_path)}.')

obsws_cli/commands/settings.py

@@ -0,0 +1,340 @@
+"""module for settings management."""
+
+from typing import Annotated, Optional
+
+import typer
+from rich.table import Table
+from rich.text import Text
+
+from obsws_cli import console, util
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Manage OBS settings."""
+
+
+@app.command('show')
+@app.command('sh', hidden=True)
+def show(
+    ctx: typer.Context,
+    video: Annotated[
+        bool, typer.Option('--video', '-v', help='Show video settings.')
+    ] = False,
+    record: Annotated[
+        bool, typer.Option('--record', '-r', help='Show recording settings.')
+    ] = False,
+    profile: Annotated[
+        bool, typer.Option('--profile', '-p', help='Show profile settings.')
+    ] = False,
+):
+    """Show current OBS settings."""
+    if not any([video, record, profile]):
+        video = True
+        record = True
+        profile = True
+
+    resp = ctx.obj['obsws'].get_video_settings()
+    video_table = Table(
+        title='Video Settings',
+        padding=(0, 2),
+        border_style=ctx.obj['style'].border,
+    )
+    video_columns = (
+        ('Setting', 'left', ctx.obj['style'].column),
+        ('Value', 'left', ctx.obj['style'].column),
+    )
+
+    for header_text, justify, style in video_columns:
+        video_table.add_column(
+            Text(header_text, justify='center'),
+            justify=justify,
+            style=style,
+        )
+
+    for setting in resp.attrs():
+        video_table.add_row(
+            util.snakecase_to_titlecase(setting),
+            str(getattr(resp, setting)),
+            style='' if video_table.row_count % 2 == 0 else 'dim',
+        )
+
+    if video:
+        console.out.print(video_table)
+
+    resp = ctx.obj['obsws'].get_record_directory()
+    record_table = Table(
+        title='Recording Settings',
+        padding=(0, 2),
+        border_style=ctx.obj['style'].border,
+    )
+    record_columns = (
+        ('Setting', 'left', ctx.obj['style'].column),
+        ('Value', 'left', ctx.obj['style'].column),
+    )
+    for header_text, justify, style in record_columns:
+        record_table.add_column(
+            Text(header_text, justify='center'),
+            justify=justify,
+            style=style,
+        )
+
+    record_table.add_row(
+        'Directory',
+        resp.record_directory,
+        style='' if record_table.row_count % 2 == 0 else 'dim',
+    )
+
+    if record:
+        console.out.print(record_table)
+
+    profile_table = Table(
+        title='Profile Settings',
+        padding=(0, 2),
+        border_style=ctx.obj['style'].border,
+    )
+    profile_columns = (
+        ('Setting', 'left', ctx.obj['style'].column),
+        ('Value', 'left', ctx.obj['style'].column),
+    )
+    for header_text, justify, style in profile_columns:
+        profile_table.add_column(
+            Text(header_text, justify='center'),
+            justify=justify,
+            style=style,
+        )
+
+    params = [
+        ('Output', 'Mode', 'Output Mode'),
+        ('SimpleOutput', 'StreamEncoder', 'Simple Streaming Encoder'),
+        ('SimpleOutput', 'RecEncoder', 'Simple Recording Encoder'),
+        ('SimpleOutput', 'RecFormat2', 'Simple Recording Video Format'),
+        ('SimpleOutput', 'RecAudioEncoder', 'Simple Recording Audio Format'),
+        ('SimpleOutput', 'RecQuality', 'Simple Recording Quality'),
+        ('AdvOut', 'Encoder', 'Advanced Streaming Encoder'),
+        ('AdvOut', 'RecEncoder', 'Advanced Recording Encoder'),
+        ('AdvOut', 'RecType', 'Advanced Recording Type'),
+        ('AdvOut', 'RecFormat2', 'Advanced Recording Video Format'),
+        ('AdvOut', 'RecAudioEncoder', 'Advanced Recording Audio Format'),
+    ]
+
+    for category, name, display_name in params:
+        resp = ctx.obj['obsws'].get_profile_parameter(
+            category=category,
+            name=name,
+        )
+        if resp.parameter_value is not None:
+            profile_table.add_row(
+                display_name,
+                str(resp.parameter_value),
+                style='' if profile_table.row_count % 2 == 0 else 'dim',
+            )
+
+    if profile:
+        console.out.print(profile_table)
+
+
+@app.command('profile')
+@app.command('pr', hidden=True)
+def profile(
+    ctx: typer.Context,
+    category: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            help='Profile parameter category (e.g., SimpleOutput, AdvOut).',
+        ),
+    ],
+    name: Annotated[
+        str,
+        typer.Argument(
+            ...,
+            help='Profile parameter name (e.g., StreamEncoder, RecFormat2).',
+        ),
+    ],
+    value: Annotated[
+        Optional[str],
+        typer.Argument(
+            ...,
+            help='Value to set for the profile parameter. If omitted, the current value is retrieved.',
+        ),
+    ] = None,
+):
+    """Get/set OBS profile settings."""
+    if value is None:
+        resp = ctx.obj['obsws'].get_profile_parameter(
+            category=category,
+            name=name,
+        )
+        console.out.print(
+            f'Parameter Value for [bold]{name}[/bold]: '
+            f'[green]{resp.parameter_value}[/green]'
+        )
+    else:
+        ctx.obj['obsws'].set_profile_parameter(
+            category=category,
+            name=name,
+            value=value,
+        )
+        console.out.print(
+            f'Set Parameter [bold]{name}[/bold] to [green]{value}[/green]'
+        )
+
+
+@app.command('stream-service')
+@app.command('ss', hidden=True)
+def stream_service(
+    ctx: typer.Context,
+    type_: Annotated[
+        Optional[str],
+        typer.Argument(
+            ...,
+            help='Stream service type (e.g., Twitch, YouTube). If omitted, current settings are retrieved.',
+        ),
+    ] = None,
+    key: Annotated[
+        Optional[str],
+        typer.Option('--key', '-k', help='Stream key to set. Optional.'),
+    ] = None,
+    server: Annotated[
+        Optional[str],
+        typer.Option('--server', '-s', help='Stream server to set. Optional.'),
+    ] = None,
+):
+    """Get/set OBS stream service settings."""
+    if type_ is None:
+        resp = ctx.obj['obsws'].get_stream_service_settings()
+        table = Table(
+            title='Stream Service Settings',
+            padding=(0, 2),
+            border_style=ctx.obj['style'].border,
+        )
+        columns = (
+            ('Setting', 'left', ctx.obj['style'].column),
+            ('Value', 'left', ctx.obj['style'].column),
+        )
+        for header_text, justify, style in columns:
+            table.add_column(
+                Text(header_text, justify='center'),
+                justify=justify,
+                style=style,
+            )
+        table.add_row(
+            'Type',
+            resp.stream_service_type,
+            style='' if table.row_count % 2 == 0 else 'dim',
+        )
+        table.add_row(
+            'Server',
+            resp.stream_service_settings.get('server', ''),
+            style='' if table.row_count % 2 == 0 else 'dim',
+        )
+        table.add_row(
+            'Key',
+            resp.stream_service_settings.get('key', ''),
+            style='' if table.row_count % 2 == 0 else 'dim',
+        )
+        console.out.print(table)
+    else:
+        current_settings = ctx.obj['obsws'].get_stream_service_settings()
+        if key is None:
+            key = current_settings.stream_service_settings.get('key', '')
+        if server is None:
+            server = current_settings.stream_service_settings.get('server', '')
+
+        ctx.obj['obsws'].set_stream_service_settings(
+            ss_type=type_,
+            ss_settings={'key': key, 'server': server},
+        )
+        console.out.print('Stream service settings updated.')
+
+
+@app.command('video')
+@app.command('vi', hidden=True)
+def video(
+    ctx: typer.Context,
+    base_width: Annotated[
+        Optional[int],
+        typer.Option('--base-width', '-bw', help='Set base (canvas) width.'),
+    ] = None,
+    base_height: Annotated[
+        Optional[int],
+        typer.Option('--base-height', '-bh', help='Set base (canvas) height.'),
+    ] = None,
+    output_width: Annotated[
+        Optional[int],
+        typer.Option('--output-width', '-ow', help='Set output (scaled) width.'),
+    ] = None,
+    output_height: Annotated[
+        Optional[int],
+        typer.Option('--output-height', '-oh', help='Set output (scaled) height.'),
+    ] = None,
+    fps_num: Annotated[
+        Optional[int],
+        typer.Option('--fps-num', '-fn', help='Set FPS numerator.'),
+    ] = None,
+    fps_den: Annotated[
+        Optional[int],
+        typer.Option('--fps-den', '-fd', help='Set FPS denominator.'),
+    ] = None,
+):
+    """Get/set OBS video settings."""
+    if not any(
+        [
+            base_width,
+            base_height,
+            output_width,
+            output_height,
+            fps_num,
+            fps_den,
+        ]
+    ):
+        resp = ctx.obj['obsws'].get_video_settings()
+        table = Table(
+            title='Video Settings',
+            padding=(0, 2),
+            border_style=ctx.obj['style'].border,
+        )
+        columns = (
+            ('Setting', 'left', ctx.obj['style'].column),
+            ('Value', 'left', ctx.obj['style'].column),
+        )
+        for header_text, justify, style in columns:
+            table.add_column(
+                Text(header_text, justify='center'),
+                justify=justify,
+                style=style,
+            )
+        for setting in resp.attrs():
+            table.add_row(
+                util.snakecase_to_titlecase(setting),
+                str(getattr(resp, setting)),
+                style='' if table.row_count % 2 == 0 else 'dim',
+            )
+        console.out.print(table)
+    else:
+        current_settings = ctx.obj['obsws'].get_video_settings()
+        if base_width is None:
+            base_width = current_settings.base_width
+        if base_height is None:
+            base_height = current_settings.base_height
+        if output_width is None:
+            output_width = current_settings.output_width
+        if output_height is None:
+            output_height = current_settings.output_height
+        if fps_num is None:
+            fps_num = current_settings.fps_num
+        if fps_den is None:
+            fps_den = current_settings.fps_den
+
+        ctx.obj['obsws'].set_video_settings(
+            base_width=base_width,
+            base_height=base_height,
+            out_width=output_width,
+            out_height=output_height,
+            numerator=fps_num,
+            denominator=fps_den,
+        )
+        console.out.print('Video settings updated.')

obsws_cli/commands/stream.py

@@ -1,13 +1,10 @@
 """module for controlling OBS stream functionality."""
 
 import typer
-from rich.console import Console
 
-from .alias import AliasGroup
+from obsws_cli import console
 
-app = typer.Typer(cls=AliasGroup)
-out_console = Console()
-err_console = Console(stderr=True)
+app = typer.Typer()
 
 
 @app.callback()
@@ -17,45 +14,49 @@ def main():
 
 def _get_streaming_status(ctx: typer.Context) -> tuple:
     """Get streaming status."""
-    resp = ctx.obj.get_stream_status()
+    resp = ctx.obj['obsws'].get_stream_status()
     return resp.output_active, resp.output_duration
 
 
-@app.command('start | s')
+@app.command('start')
+@app.command('s', hidden=True)
 def start(ctx: typer.Context):
     """Start streaming."""
     active, _ = _get_streaming_status(ctx)
     if active:
-        err_console.print('Streaming is already in progress, cannot start.')
+        console.err.print('Streaming is already in progress, cannot start.')
         raise typer.Exit(1)
 
-    ctx.obj.start_stream()
-    out_console.print('Streaming started successfully.')
+    ctx.obj['obsws'].start_stream()
+    console.out.print('Streaming started successfully.')
 
 
-@app.command('stop | st')
+@app.command('stop')
+@app.command('st', hidden=True)
 def stop(ctx: typer.Context):
     """Stop streaming."""
     active, _ = _get_streaming_status(ctx)
     if not active:
-        err_console.print('Streaming is not in progress, cannot stop.')
+        console.err.print('Streaming is not in progress, cannot stop.')
         raise typer.Exit(1)
 
-    ctx.obj.stop_stream()
-    out_console.print('Streaming stopped successfully.')
+    ctx.obj['obsws'].stop_stream()
+    console.out.print('Streaming stopped successfully.')
 
 
-@app.command('toggle | tg')
+@app.command('toggle')
+@app.command('tg', hidden=True)
 def toggle(ctx: typer.Context):
     """Toggle streaming."""
-    resp = ctx.obj.toggle_stream()
+    resp = ctx.obj['obsws'].toggle_stream()
     if resp.output_active:
-        out_console.print('Streaming started successfully.')
+        console.out.print('Streaming started successfully.')
     else:
-        out_console.print('Streaming stopped successfully.')
+        console.out.print('Streaming stopped successfully.')
 
 
-@app.command('status | ss')
+@app.command('status')
+@app.command('ss', hidden=True)
 def status(ctx: typer.Context):
     """Get streaming status."""
     active, duration = _get_streaming_status(ctx)
@@ -65,19 +66,19 @@ def status(ctx: typer.Context):
             minutes = int(seconds // 60)
             seconds = int(seconds % 60)
             if minutes > 0:
-                out_console.print(
+                console.out.print(
                     f'Streaming is in progress for {minutes} minutes and {seconds} seconds.'
                 )
             else:
                 if seconds > 0:
-                    out_console.print(
+                    console.out.print(
                         f'Streaming is in progress for {seconds} seconds.'
                     )
                 else:
-                    out_console.print(
+                    console.out.print(
                         'Streaming is in progress for less than a second.'
                     )
         else:
-            out_console.print('Streaming is in progress.')
+            console.out.print('Streaming is in progress.')
     else:
-        out_console.print('Streaming is not in progress.')
+        console.out.print('Streaming is not in progress.')

obsws_cli/commands/studiomode.py

@@ -0,0 +1,52 @@
+"""module containing commands for manipulating studio mode in OBS."""
+
+import typer
+
+from obsws_cli import console
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Control studio mode in OBS."""
+
+
+@app.command('enable')
+@app.command('on', hidden=True)
+def enable(ctx: typer.Context):
+    """Enable studio mode."""
+    ctx.obj['obsws'].set_studio_mode_enabled(True)
+    console.out.print('Studio mode has been enabled.')
+
+
+@app.command('disable')
+@app.command('off', hidden=True)
+def disable(ctx: typer.Context):
+    """Disable studio mode."""
+    ctx.obj['obsws'].set_studio_mode_enabled(False)
+    console.out.print('Studio mode has been disabled.')
+
+
+@app.command('toggle')
+@app.command('tg', hidden=True)
+def toggle(ctx: typer.Context):
+    """Toggle studio mode."""
+    resp = ctx.obj['obsws'].get_studio_mode_enabled()
+    if resp.studio_mode_enabled:
+        ctx.obj['obsws'].set_studio_mode_enabled(False)
+        console.out.print('Studio mode is now disabled.')
+    else:
+        ctx.obj['obsws'].set_studio_mode_enabled(True)
+        console.out.print('Studio mode is now enabled.')
+
+
+@app.command('status')
+@app.command('ss', hidden=True)
+def status(ctx: typer.Context):
+    """Get the status of studio mode."""
+    resp = ctx.obj['obsws'].get_studio_mode_enabled()
+    if resp.studio_mode_enabled:
+        console.out.print('Studio mode is enabled.')
+    else:
+        console.out.print('Studio mode is disabled.')

obsws_cli/commands/text.py

@@ -0,0 +1,79 @@
+"""module containing commands for manipulating text inputs."""
+
+from typing import Annotated, Optional
+
+import typer
+
+from obsws_cli import console, validate
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Control text inputs in OBS."""
+
+
+@app.command('current')
+@app.command('get', hidden=True)
+def current(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str,
+        typer.Argument(
+            help='Name of the text input to get.', callback=validate.input_in_inputs
+        ),
+    ],
+):
+    """Get the current text for a text input."""
+    resp = ctx.obj['obsws'].get_input_settings(name=input_name)
+    if not resp.input_kind.startswith('text_'):
+        console.err.print(
+            f'Input [yellow]{input_name}[/yellow] is not a text input.',
+        )
+        raise typer.Exit(1)
+
+    current_text = resp.input_settings.get('text', '')
+    if not current_text:
+        current_text = '(empty)'
+    console.out.print(
+        f'Current text for input {console.highlight(ctx, input_name)}: {current_text}',
+    )
+
+
+@app.command('update')
+@app.command('set', hidden=True)
+def update(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str,
+        typer.Argument(
+            help='Name of the text input to update.', callback=validate.input_in_inputs
+        ),
+    ],
+    new_text: Annotated[
+        Optional[str],
+        typer.Argument(
+            help='The new text to set for the input.',
+        ),
+    ] = None,
+):
+    """Update the text of a text input."""
+    resp = ctx.obj['obsws'].get_input_settings(name=input_name)
+    if not resp.input_kind.startswith('text_'):
+        console.err.print(
+            f'Input [yellow]{input_name}[/yellow] is not a text input.',
+        )
+        raise typer.Exit(1)
+
+    ctx.obj['obsws'].set_input_settings(
+        name=input_name,
+        settings={'text': new_text},
+        overlay=True,
+    )
+
+    if not new_text:
+        new_text = '(empty)'
+    console.out.print(
+        f'Text for input {console.highlight(ctx, input_name)} updated to: {new_text}',
+    )

obsws_cli/commands/virtualcam.py

@@ -0,0 +1,50 @@
+"""module containing commands for manipulating virtual camera in OBS."""
+
+import typer
+
+from obsws_cli import console
+
+app = typer.Typer()
+
+
+@app.callback()
+def main():
+    """Control virtual camera in OBS."""
+
+
+@app.command('start')
+@app.command('s', hidden=True)
+def start(ctx: typer.Context):
+    """Start the virtual camera."""
+    ctx.obj['obsws'].start_virtual_cam()
+    console.out.print('Virtual camera started.')
+
+
+@app.command('stop')
+@app.command('p', hidden=True)
+def stop(ctx: typer.Context):
+    """Stop the virtual camera."""
+    ctx.obj['obsws'].stop_virtual_cam()
+    console.out.print('Virtual camera stopped.')
+
+
+@app.command('toggle')
+@app.command('tg', hidden=True)
+def toggle(ctx: typer.Context):
+    """Toggle the virtual camera."""
+    resp = ctx.obj['obsws'].toggle_virtual_cam()
+    if resp.output_active:
+        console.out.print('Virtual camera is enabled.')
+    else:
+        console.out.print('Virtual camera is disabled.')
+
+
+@app.command('status')
+@app.command('ss', hidden=True)
+def status(ctx: typer.Context):
+    """Get the status of the virtual camera."""
+    resp = ctx.obj['obsws'].get_virtual_cam_status()
+    if resp.output_active:
+        console.out.print('Virtual camera is enabled.')
+    else:
+        console.out.print('Virtual camera is disabled.')

obsws_cli/console.py

@@ -0,0 +1,12 @@
+"""module for console output handling in obsws_cli."""
+
+import typer
+from rich.console import Console
+
+out = Console()
+err = Console(stderr=True, style='bold red')
+
+
+def highlight(ctx: typer.Context, text: str) -> str:
+    """Highlight text using the current context's style."""
+    return f'[{ctx.obj["style"].highlight}]{text}[/{ctx.obj["style"].highlight}]'

obsws_cli/envconfig.py

@@ -0,0 +1,146 @@
+"""module for settings management for obsws-cli."""
+
+from collections import UserDict
+from pathlib import Path
+from typing import Any, Union
+
+from dotenv import dotenv_values
+
+ConfigValue = Union[str, int, bool]
+
+
+class EnvConfig(UserDict):
+    """A class to manage .env config for obsws-cli.
+
+    This class extends UserDict to provide a dictionary-like interface for config.
+    It loads config from .env files in the following priority:
+    1. Local .env file
+    2. User config file (~/.config/obsws-cli/obsws.env)
+    3. Default values
+
+    Note, typer handles reading from environment variables automatically. They take precedence
+    over values set in this class.
+
+    The config values are expected to be in uppercase and should start with 'OBSWS_CLI_'.
+
+    Example:
+    -------
+        config = EnvConfig()
+        host = config['OBSWS_CLI_HOST']
+        config['OBSWS_CLI_PORT'] = 4455
+        # Or with defaults
+        timeout = config.get('OBSWS_CLI_TIMEOUT', 30)
+        # Keys will be normalised to uppercase with prefix
+        debug = config.get('debug', False)  # Equivalent to 'OBSWS_CLI_DEBUG'
+
+    """
+
+    PREFIX = 'OBSWS_CLI_'
+
+    def __init__(self, *args, **kwargs):
+        """Initialize the Config object with hierarchical loading."""
+        kwargs.update(
+            {
+                **dotenv_values(Path.home() / '.config' / 'obsws-cli' / 'obsws.env'),
+                **dotenv_values('.env'),
+            }
+        )
+
+        super().__init__(*args, **self._convert_types(kwargs))
+
+    def _convert_types(self, config_data: dict[str, Any]) -> dict[str, ConfigValue]:
+        """Convert string values to appropriate types."""
+        converted = {}
+        for key, value in config_data.items():
+            if isinstance(value, str):
+                if value.lower() in ('true', 'false'):
+                    converted[key] = value.lower() == 'true'
+                elif value.isdigit():
+                    converted[key] = int(value)
+                else:
+                    converted[key] = value
+            else:
+                converted[key] = value
+        return converted
+
+    def __getitem__(self, key: str) -> ConfigValue:
+        """Get a setting value by key."""
+        normalised_key = self._normalise_key(key)
+        try:
+            return self.data[normalised_key]
+        except KeyError as e:
+            raise KeyError(
+                f"Config key '{key}' not found. Available keys: {list(self.data.keys())}"
+            ) from e
+
+    def __setitem__(self, key: str, value: ConfigValue):
+        """Set a setting value by key."""
+        normalised_key = self._normalise_key(key)
+        self.data[normalised_key] = value
+
+    def _normalise_key(self, key: str) -> str:
+        """Normalise a key to uppercase with OBS_ prefix."""
+        key = key.upper()
+        if not key.startswith(self.PREFIX):
+            key = f'{self.PREFIX}{key}'
+        return key
+
+    def get(self, key: str, default=None) -> ConfigValue:
+        """Get a config value with optional default.
+
+        Args:
+        ----
+            key (str): The key to retrieve
+            default: Default value if key is not found
+
+        Returns:
+        -------
+            The config value or default
+
+        """
+        normalised_key = self._normalise_key(key)
+        if not self.has_key(normalised_key):
+            return default
+        return self[normalised_key]
+
+    def has_key(self, key: str) -> bool:
+        """Check if a config key exists.
+
+        Args:
+        ----
+            key (str): The key to check
+
+        Returns:
+        -------
+            bool: True if key exists, False otherwise
+
+        """
+        normalised_key = self._normalise_key(key)
+        return normalised_key in self.data
+
+
+_envconfig = EnvConfig(
+    OBSWS_CLI_HOST='localhost',
+    OBSWS_CLI_PORT=4455,
+    OBSWS_CLI_PASSWORD='',
+    OBSWS_CLI_TIMEOUT=5,
+    OBSWS_CLI_LOGLEVEL='WARNING',
+    OBSWS_CLI_STYLE='disabled',
+    OBSWS_CLI_STYLE_NO_BORDER=False,
+)
+
+
+def get(key: str) -> ConfigValue:
+    """Get a setting value by key from the global config instance.
+
+    Args:
+    ----
+        key (str): The key of the config to retrieve.
+        default: Default value if key is not found.
+
+    Returns:
+    -------
+        The value of the config or default value.
+
+    """
+    return _envconfig.get(key)

obsws_cli/filter.py

@@ -1,134 +0,0 @@
-"""module containing commands for manipulating filters in scenes."""
-
-import obsws_python as obsws
-import typer
-from rich.console import Console
-from rich.table import Table
-
-from . import util
-from .alias import AliasGroup
-
-app = typer.Typer(cls=AliasGroup)
-out_console = Console()
-err_console = Console(stderr=True)
-
-
-@app.callback()
-def main():
-    """Control filters in OBS scenes."""
-
-
-@app.command('list | ls')
-def list(ctx: typer.Context, source_name: str):
-    """List filters for a source."""
-    try:
-        resp = ctx.obj.get_source_filter_list(source_name)
-    except obsws.error.OBSSDKRequestError as e:
-        if e.code == 600:
-            err_console.print(f"No source was found by the name of '{source_name}'.")
-            raise typer.Exit(1)
-        else:
-            raise
-
-    if not resp.filters:
-        out_console.print(f'No filters found for source {source_name}')
-        raise typer.Exit()
-
-    table = Table(title=f'Filters for Source: {source_name}', padding=(0, 2))
-
-    for column in ('Filter Name', 'Kind', 'Enabled', 'Settings'):
-        table.add_column(
-            column,
-            justify='left' if column in ('Filter Name', 'Kind') else 'center',
-            style='cyan',
-        )
-
-    for filter in resp.filters:
-        table.add_row(
-            filter['filterName'],
-            util.snakecase_to_titlecase(filter['filterKind']),
-            ':white_heavy_check_mark:' if filter['filterEnabled'] else ':x:',
-            '\n'.join(
-                [
-                    f'{util.snakecase_to_titlecase(k):<20} {v:>10}'
-                    for k, v in filter['filterSettings'].items()
-                ]
-            ),
-        )
-
-    out_console.print(table)
-
-
-def _get_filter_enabled(ctx: typer.Context, source_name: str, filter_name: str):
-    """Get the status of a filter for a source."""
-    resp = ctx.obj.get_source_filter(source_name, filter_name)
-    return resp.filter_enabled
-
-
-@app.command('enable | on')
-def enable(
-    ctx: typer.Context,
-    source_name: str = typer.Argument(..., help='The source to enable the filter for'),
-    filter_name: str = typer.Argument(..., help='The name of the filter to enable'),
-):
-    """Enable a filter for a source."""
-    if _get_filter_enabled(ctx, source_name, filter_name):
-        err_console.print(
-            f'Filter {filter_name} is already enabled for source {source_name}'
-        )
-        raise typer.Exit(1)
-
-    ctx.obj.set_source_filter_enabled(source_name, filter_name, enabled=True)
-    out_console.print(f'Enabled filter {filter_name} for source {source_name}')
-
-
-@app.command('disable | off')
-def disable(
-    ctx: typer.Context,
-    source_name: str = typer.Argument(..., help='The source to disable the filter for'),
-    filter_name: str = typer.Argument(..., help='The name of the filter to disable'),
-):
-    """Disable a filter for a source."""
-    if not _get_filter_enabled(ctx, source_name, filter_name):
-        err_console.print(
-            f'Filter {filter_name} is already disabled for source {source_name}'
-        )
-        raise typer.Exit(1)
-
-    ctx.obj.set_source_filter_enabled(source_name, filter_name, enabled=False)
-    out_console.print(f'Disabled filter {filter_name} for source {source_name}')
-
-
-@app.command('toggle | tg')
-def toggle(
-    ctx: typer.Context,
-    source_name: str = typer.Argument(..., help='The source to toggle the filter for'),
-    filter_name: str = typer.Argument(..., help='The name of the filter to toggle'),
-):
-    """Toggle a filter for a source."""
-    is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
-    new_state = not is_enabled
-
-    ctx.obj.set_source_filter_enabled(source_name, filter_name, enabled=new_state)
-    if new_state:
-        out_console.print(f'Enabled filter {filter_name} for source {source_name}')
-    else:
-        out_console.print(f'Disabled filter {filter_name} for source {source_name}')
-
-
-@app.command('status | ss')
-def status(
-    ctx: typer.Context,
-    source_name: str = typer.Argument(
-        ..., help='The source to get the filter status for'
-    ),
-    filter_name: str = typer.Argument(
-        ..., help='The name of the filter to get the status for'
-    ),
-):
-    """Get the status of a filter for a source."""
-    is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
-    if is_enabled:
-        out_console.print(f'Filter {filter_name} is enabled for source {source_name}')
-    else:
-        out_console.print(f'Filter {filter_name} is disabled for source {source_name}')

obsws_cli/group.py

@@ -1,164 +0,0 @@
-"""module containing commands for manipulating groups in scenes."""
-
-import typer
-from rich.console import Console
-from rich.table import Table
-
-from . import validate
-from .alias import AliasGroup
-from .protocols import DataclassProtocol
-
-app = typer.Typer(cls=AliasGroup)
-out_console = Console()
-err_console = Console(stderr=True)
-
-
-@app.callback()
-def main():
-    """Control groups in OBS scenes."""
-
-
-@app.command('list | ls')
-def list(
-    ctx: typer.Context,
-    scene_name: str = typer.Argument(
-        None, help='Scene name (optional, defaults to current scene)'
-    ),
-):
-    """List groups in a scene."""
-    if not scene_name:
-        scene_name = ctx.obj.get_current_program_scene().scene_name
-
-    if not validate.scene_in_scenes(ctx, scene_name):
-        err_console.print(f"Scene '{scene_name}' not found.")
-        raise typer.Exit(1)
-
-    resp = ctx.obj.get_scene_item_list(scene_name)
-    groups = [
-        (item.get('sceneItemId'), item.get('sourceName'), item.get('sceneItemEnabled'))
-        for item in resp.scene_items
-        if item.get('isGroup')
-    ]
-
-    if not groups:
-        out_console.print(f"No groups found in scene '{scene_name}'.")
-        raise typer.Exit()
-
-    table = Table(title=f'Groups in Scene: {scene_name}', padding=(0, 2))
-
-    for column in ('ID', 'Group Name', 'Enabled'):
-        table.add_column(
-            column, justify='left' if column == 'Group Name' else 'center', style='cyan'
-        )
-
-    for item_id, group_name, is_enabled in groups:
-        table.add_row(
-            str(item_id),
-            group_name,
-            ':white_heavy_check_mark:' if is_enabled else ':x:',
-        )
-
-    out_console.print(table)
-
-
-def _get_group(group_name: str, resp: DataclassProtocol) -> dict | None:
-    """Get a group from the scene item list response."""
-    group = next(
-        (
-            item
-            for item in resp.scene_items
-            if item.get('sourceName') == group_name and item.get('isGroup')
-        ),
-        None,
-    )
-    return group
-
-
-@app.command('show | sh')
-def show(ctx: typer.Context, scene_name: str, group_name: str):
-    """Show a group in a scene."""
-    if not validate.scene_in_scenes(ctx, scene_name):
-        err_console.print(f"Scene '{scene_name}' not found.")
-        raise typer.Exit(1)
-
-    resp = ctx.obj.get_scene_item_list(scene_name)
-    if (group := _get_group(group_name, resp)) is None:
-        err_console.print(f"Group '{group_name}' not found in scene {scene_name}.")
-        raise typer.Exit(1)
-
-    ctx.obj.set_scene_item_enabled(
-        scene_name=scene_name,
-        item_id=int(group.get('sceneItemId')),
-        enabled=True,
-    )
-
-    out_console.print(f"Group '{group_name}' is now visible.")
-
-
-@app.command('hide | h')
-def hide(ctx: typer.Context, scene_name: str, group_name: str):
-    """Hide a group in a scene."""
-    if not validate.scene_in_scenes(ctx, scene_name):
-        err_console.print(f"Scene '{scene_name}' not found.")
-        raise typer.Exit(1)
-
-    resp = ctx.obj.get_scene_item_list(scene_name)
-    if (group := _get_group(group_name, resp)) is None:
-        err_console.print(f"Group '{group_name}' not found in scene {scene_name}.")
-        raise typer.Exit(1)
-
-    ctx.obj.set_scene_item_enabled(
-        scene_name=scene_name,
-        item_id=int(group.get('sceneItemId')),
-        enabled=False,
-    )
-
-    out_console.print(f"Group '{group_name}' is now hidden.")
-
-
-@app.command('toggle | tg')
-def toggle(ctx: typer.Context, scene_name: str, group_name: str):
-    """Toggle a group in a scene."""
-    if not validate.scene_in_scenes(ctx, scene_name):
-        err_console.print(f"Scene '{scene_name}' not found.")
-        raise typer.Exit(1)
-
-    resp = ctx.obj.get_scene_item_list(scene_name)
-    if (group := _get_group(group_name, resp)) is None:
-        err_console.print(f"Group '{group_name}' not found in scene {scene_name}.")
-        raise typer.Exit(1)
-
-    new_state = not group.get('sceneItemEnabled')
-    ctx.obj.set_scene_item_enabled(
-        scene_name=scene_name,
-        item_id=int(group.get('sceneItemId')),
-        enabled=new_state,
-    )
-
-    if new_state:
-        out_console.print(f"Group '{group_name}' is now visible.")
-    else:
-        out_console.print(f"Group '{group_name}' is now hidden.")
-
-
-@app.command('status | ss')
-def status(ctx: typer.Context, scene_name: str, group_name: str):
-    """Get the status of a group in a scene."""
-    if not validate.scene_in_scenes(ctx, scene_name):
-        err_console.print(f"Scene '{scene_name}' not found.")
-        raise typer.Exit(1)
-
-    resp = ctx.obj.get_scene_item_list(scene_name)
-    if (group := _get_group(group_name, resp)) is None:
-        err_console.print(f"Group '{group_name}' not found in scene {scene_name}.")
-        raise typer.Exit(1)
-
-    enabled = ctx.obj.get_scene_item_enabled(
-        scene_name=scene_name,
-        item_id=int(group.get('sceneItemId')),
-    )
-
-    if enabled.scene_item_enabled:
-        out_console.print(f"Group '{group_name}' is now visible.")
-    else:
-        out_console.print(f"Group '{group_name}' is now hidden.")

obsws_cli/hotkey.py

@@ -1,57 +0,0 @@
-"""module containing commands for hotkey management."""
-
-import typer
-from rich.console import Console
-from rich.table import Table
-
-from .alias import AliasGroup
-
-app = typer.Typer(cls=AliasGroup)
-out_console = Console()
-err_console = Console(stderr=True)
-
-
-@app.callback()
-def main():
-    """Control hotkeys in OBS."""
-
-
-@app.command('list | ls')
-def list(
-    ctx: typer.Context,
-):
-    """List all hotkeys."""
-    resp = ctx.obj.get_hotkey_list()
-
-    table = Table(title='Hotkeys', padding=(0, 2))
-    table.add_column('Hotkey Name', justify='left', style='cyan')
-
-    for hotkey in resp.hotkeys:
-        table.add_row(hotkey)
-
-    out_console.print(table)
-
-
-@app.command('trigger | tr')
-def trigger(
-    ctx: typer.Context,
-    hotkey: str = typer.Argument(..., help='The hotkey to trigger'),
-):
-    """Trigger a hotkey by name."""
-    ctx.obj.trigger_hotkey_by_name(hotkey)
-
-
-@app.command('trigger-sequence | trs')
-def trigger_sequence(
-    ctx: typer.Context,
-    shift: bool = typer.Option(False, help='Press shift when triggering the hotkey'),
-    ctrl: bool = typer.Option(False, help='Press control when triggering the hotkey'),
-    alt: bool = typer.Option(False, help='Press alt when triggering the hotkey'),
-    cmd: bool = typer.Option(False, help='Press cmd when triggering the hotkey'),
-    key_id: str = typer.Argument(
-        ...,
-        help='The OBS key ID to trigger, see https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#hotkey for more info',
-    ),
-):
-    """Trigger a hotkey by sequence."""
-    ctx.obj.trigger_hotkey_by_key_sequence(key_id, shift, ctrl, alt, cmd)

obsws_cli/input.py

@@ -1,116 +0,0 @@
-"""module containing commands for manipulating inputs."""
-
-from typing import Annotated
-
-import typer
-from rich.console import Console
-from rich.table import Table
-
-from . import util, validate
-from .alias import AliasGroup
-
-app = typer.Typer(cls=AliasGroup)
-out_console = Console()
-err_console = Console(stderr=True)
-
-
-@app.callback()
-def main():
-    """Control inputs in OBS."""
-
-
-@app.command('list | ls')
-def list(
-    ctx: typer.Context,
-    input: Annotated[bool, typer.Option(help='Filter by input type.')] = False,
-    output: Annotated[bool, typer.Option(help='Filter by output type.')] = False,
-    colour: Annotated[bool, typer.Option(help='Filter by colour source type.')] = False,
-):
-    """List all inputs."""
-    resp = ctx.obj.get_input_list()
-
-    kinds = []
-    if input:
-        kinds.append('input')
-    if output:
-        kinds.append('output')
-    if colour:
-        kinds.append('color')
-    if not any([input, output, colour]):
-        kinds = ['input', 'output', 'color']
-
-    inputs = [
-        (input_.get('inputName'), input_.get('inputKind'))
-        for input_ in filter(
-            lambda input_: any(kind in input_.get('inputKind') for kind in kinds),
-            resp.inputs,
-        )
-    ]
-
-    if not inputs:
-        out_console.print('No inputs found.')
-        raise typer.Exit()
-
-    table = Table(title='Inputs', padding=(0, 2))
-    for column in ('Input Name', 'Kind'):
-        table.add_column(
-            column, justify='left' if column == 'Input Name' else 'center', style='cyan'
-        )
-
-    for input_name, input_kind in inputs:
-        table.add_row(
-            input_name,
-            util.snakecase_to_titlecase(input_kind),
-        )
-
-    out_console.print(table)
-
-
-@app.command('mute | m')
-def mute(ctx: typer.Context, input_name: str):
-    """Mute an input."""
-    if not validate.input_in_inputs(ctx, input_name):
-        err_console.print(f"Input '{input_name}' not found.")
-        raise typer.Exit(1)
-
-    ctx.obj.set_input_mute(
-        name=input_name,
-        muted=True,
-    )
-
-    out_console.print(f"Input '{input_name}' muted.")
-
-
-@app.command('unmute | um')
-def unmute(ctx: typer.Context, input_name: str):
-    """Unmute an input."""
-    if not validate.input_in_inputs(ctx, input_name):
-        err_console.print(f"Input '{input_name}' not found.")
-        raise typer.Exit(1)
-
-    ctx.obj.set_input_mute(
-        name=input_name,
-        muted=False,
-    )
-
-    out_console.print(f"Input '{input_name}' unmuted.")
-
-
-@app.command('toggle | tg')
-def toggle(ctx: typer.Context, input_name: str):
-    """Toggle an input."""
-    if not validate.input_in_inputs(ctx, input_name):
-        err_console.print(f"Input '{input_name}' not found.")
-        raise typer.Exit(1)
-
-    resp = ctx.obj.get_input_mute(name=input_name)
-    new_state = not resp.input_muted
-
-    ctx.obj.set_input_mute(
-        name=input_name,
-        muted=new_state,
-    )
-
-    out_console.print(
-        f"Input '{input_name}' {'muted' if new_state else 'unmuted'}.",
-    )

obsws_cli/profile.py

@@ -1,84 +0,0 @@
-"""module containing commands for manipulating profiles in OBS."""
-
-import typer
-from rich.console import Console
-from rich.table import Table
-
-from . import validate
-from .alias import AliasGroup
-
-app = typer.Typer(cls=AliasGroup)
-out_console = Console()
-err_console = Console(stderr=True)
-
-
-@app.callback()
-def main():
-    """Control profiles in OBS."""
-
-
-@app.command('list | ls')
-def list(ctx: typer.Context):
-    """List profiles."""
-    resp = ctx.obj.get_profile_list()
-
-    table = Table(title='Profiles', padding=(0, 2))
-    for column in ('Profile Name', 'Current'):
-        table.add_column(
-            column,
-            justify='left' if column == 'Profile Name' else 'center',
-            style='cyan',
-        )
-
-    for profile in resp.profiles:
-        table.add_row(
-            profile,
-            ':white_heavy_check_mark:' if profile == resp.current_profile_name else '',
-        )
-
-    out_console.print(table)
-
-
-@app.command('current | get')
-def current(ctx: typer.Context):
-    """Get the current profile."""
-    resp = ctx.obj.get_profile_list()
-    out_console.print(resp.current_profile_name)
-
-
-@app.command('switch | set')
-def switch(ctx: typer.Context, profile_name: str):
-    """Switch to a profile."""
-    if not validate.profile_exists(ctx, profile_name):
-        err_console.print(f"Profile '{profile_name}' not found.")
-        raise typer.Exit(1)
-
-    resp = ctx.obj.get_profile_list()
-    if resp.current_profile_name == profile_name:
-        err_console.print(f"Profile '{profile_name}' is already the current profile.")
-        raise typer.Exit(1)
-
-    ctx.obj.set_current_profile(profile_name)
-    out_console.print(f"Switched to profile '{profile_name}'.")
-
-
-@app.command('create | new')
-def create(ctx: typer.Context, profile_name: str):
-    """Create a new profile."""
-    if validate.profile_exists(ctx, profile_name):
-        err_console.print(f"Profile '{profile_name}' already exists.")
-        raise typer.Exit(1)
-
-    ctx.obj.create_profile(profile_name)
-    out_console.print(f"Created profile '{profile_name}'.")
-
-
-@app.command('remove | rm')
-def remove(ctx: typer.Context, profile_name: str):
-    """Remove a profile."""
-    if not validate.profile_exists(ctx, profile_name):
-        err_console.print(f"Profile '{profile_name}' not found.")
-        raise typer.Exit(1)
-
-    ctx.obj.remove_profile(profile_name)
-    out_console.print(f"Removed profile '{profile_name}'.")

obsws_cli/projector.py

@@ -1,70 +0,0 @@
-"""module containing commands for manipulating projectors in OBS."""
-
-from typing import Annotated
-
-import typer
-from rich.console import Console
-from rich.table import Table
-
-from .alias import AliasGroup
-
-app = typer.Typer(cls=AliasGroup)
-out_console = Console()
-err_console = Console(stderr=True)
-
-
-@app.callback()
-def main():
-    """Control projectors in OBS."""
-
-
-@app.command('list-monitors | ls-m')
-def list_monitors(ctx: typer.Context):
-    """List available monitors."""
-    resp = ctx.obj.get_monitor_list()
-
-    if not resp.monitors:
-        out_console.print('No monitors found.')
-        return
-
-    monitors = sorted(
-        ((m['monitorIndex'], m['monitorName']) for m in resp.monitors),
-        key=lambda m: m[0],
-    )
-
-    table = Table(title='Available Monitors', padding=(0, 2))
-    table.add_column('Index', justify='center', style='cyan')
-    table.add_column('Name', style='cyan')
-
-    for index, monitor in monitors:
-        table.add_row(str(index), monitor)
-
-    out_console.print(table)
-
-
-@app.command('open | o')
-def open(
-    ctx: typer.Context,
-    monitor_index: Annotated[
-        int,
-        typer.Option(help='Index of the monitor to open the projector on.'),
-    ] = 0,
-    source_name: Annotated[
-        str,
-        typer.Argument(
-            help='Name of the source to project. (optional, defaults to current scene)'
-        ),
-    ] = '',
-):
-    """Open a fullscreen projector for a source on a specific monitor."""
-    if not source_name:
-        source_name = ctx.obj.get_current_program_scene().scene_name
-
-    ctx.obj.open_source_projector(
-        source_name=source_name,
-        monitor_index=monitor_index,
-    )
-
-    out_console.print(
-        f'Opened projector for source [bold]{source_name}[/] on monitor [bold]{monitor_index}[/].'
-    )

obsws_cli/record.py

@@ -1,129 +0,0 @@
-"""module for controlling OBS recording functionality."""
-
-from pathlib import Path
-from typing import Annotated, Optional
-
-import typer
-from rich.console import Console
-
-from .alias import AliasGroup
-
-app = typer.Typer(cls=AliasGroup)
-out_console = Console()
-err_console = Console(stderr=True)
-
-
-@app.callback()
-def main():
-    """Control OBS recording functionality."""
-
-
-def _get_recording_status(ctx: typer.Context) -> tuple:
-    """Get recording status."""
-    resp = ctx.obj.get_record_status()
-    return resp.output_active, resp.output_paused
-
-
-@app.command('start | s')
-def start(ctx: typer.Context):
-    """Start recording."""
-    active, paused = _get_recording_status(ctx)
-    if active:
-        err_msg = 'Recording is already in progress, cannot start.'
-        if paused:
-            err_msg += ' Try resuming it.'
-
-        err_console.print(err_msg)
-        raise typer.Exit(1)
-
-    ctx.obj.start_record()
-    out_console.print('Recording started successfully.')
-
-
-@app.command('stop | st')
-def stop(ctx: typer.Context):
-    """Stop recording."""
-    active, _ = _get_recording_status(ctx)
-    if not active:
-        err_console.print('Recording is not in progress, cannot stop.')
-        raise typer.Exit(1)
-
-    resp = ctx.obj.stop_record()
-    out_console.print(f'Recording stopped successfully. Saved to: {resp.output_path}')
-
-
-@app.command('toggle | tg')
-def toggle(ctx: typer.Context):
-    """Toggle recording."""
-    resp = ctx.obj.toggle_record()
-    if resp.output_active:
-        out_console.print('Recording started successfully.')
-    else:
-        out_console.print('Recording stopped successfully.')
-
-
-@app.command('status | ss')
-def status(ctx: typer.Context):
-    """Get recording status."""
-    active, paused = _get_recording_status(ctx)
-    if active:
-        if paused:
-            out_console.print('Recording is in progress and paused.')
-        else:
-            out_console.print('Recording is in progress.')
-    else:
-        out_console.print('Recording is not in progress.')
-
-
-@app.command('resume | r')
-def resume(ctx: typer.Context):
-    """Resume recording."""
-    active, paused = _get_recording_status(ctx)
-    if not active:
-        err_console.print('Recording is not in progress, cannot resume.')
-        raise typer.Exit(1)
-    if not paused:
-        err_console.print('Recording is in progress but not paused, cannot resume.')
-        raise typer.Exit(1)
-
-    ctx.obj.resume_record()
-    out_console.print('Recording resumed successfully.')
-
-
-@app.command('pause | p')
-def pause(ctx: typer.Context):
-    """Pause recording."""
-    active, paused = _get_recording_status(ctx)
-    if not active:
-        err_console.print('Recording is not in progress, cannot pause.')
-        raise typer.Exit(1)
-    if paused:
-        err_console.print('Recording is in progress but already paused, cannot pause.')
-        raise typer.Exit(1)
-
-    ctx.obj.pause_record()
-    out_console.print('Recording paused successfully.')
-
-
-@app.command('directory | d')
-def directory(
-    ctx: typer.Context,
-    record_directory: Annotated[
-        Optional[Path],
-        # Since the CLI and OBS may be running on different platforms,
-        # we won't validate the path here.
-        typer.Argument(
-            file_okay=False,
-            dir_okay=True,
-            help='Directory to set for recording.',
-        ),
-    ] = None,
-):
-    """Get or set the recording directory."""
-    if record_directory is not None:
-        ctx.obj.set_record_directory(str(record_directory))
-        out_console.print(f'Recording directory updated to: {record_directory}')
-    else:
-        out_console.print(
-            f'Recording directory: {ctx.obj.get_record_directory().record_directory}'
-        )

obsws_cli/replaybuffer.py

@@ -1,66 +0,0 @@
-"""module containing commands for manipulating the replay buffer in OBS."""
-
-import typer
-from rich.console import Console
-
-from .alias import AliasGroup
-
-app = typer.Typer(cls=AliasGroup)
-out_console = Console()
-err_console = Console(stderr=True)
-
-
-@app.callback()
-def main():
-    """Control profiles in OBS."""
-
-
-@app.command('start | s')
-def start(ctx: typer.Context):
-    """Start the replay buffer."""
-    resp = ctx.obj.get_replay_buffer_status()
-    if resp.output_active:
-        err_console.print('Replay buffer is already active.')
-        raise typer.Exit(1)
-
-    ctx.obj.start_replay_buffer()
-    out_console.print('Replay buffer started.')
-
-
-@app.command('stop | st')
-def stop(ctx: typer.Context):
-    """Stop the replay buffer."""
-    resp = ctx.obj.get_replay_buffer_status()
-    if not resp.output_active:
-        err_console.print('Replay buffer is not active.')
-        raise typer.Exit(1)
-
-    ctx.obj.stop_replay_buffer()
-    out_console.print('Replay buffer stopped.')
-
-
-@app.command('toggle | tg')
-def toggle(ctx: typer.Context):
-    """Toggle the replay buffer."""
-    resp = ctx.obj.toggle_replay_buffer()
-    if resp.output_active:
-        out_console.print('Replay buffer is active.')
-    else:
-        out_console.print('Replay buffer is not active.')
-
-
-@app.command('status | ss')
-def status(ctx: typer.Context):
-    """Get the status of the replay buffer."""
-    resp = ctx.obj.get_replay_buffer_status()
-    if resp.output_active:
-        out_console.print('Replay buffer is active.')
-    else:
-        out_console.print('Replay buffer is not active.')
-
-
-@app.command('save | sv')
-def save(ctx: typer.Context):
-    """Save the replay buffer."""
-    ctx.obj.save_replay_buffer()
-    out_console.print('Replay buffer saved.')

obsws_cli/scene.py

@@ -1,87 +0,0 @@
-"""module containing commands for controlling OBS scenes."""
-
-from typing import Annotated
-
-import typer
-from rich.console import Console
-from rich.table import Table
-
-from . import validate
-from .alias import AliasGroup
-
-app = typer.Typer(cls=AliasGroup)
-out_console = Console()
-err_console = Console(stderr=True)
-
-
-@app.callback()
-def main():
-    """Control OBS scenes."""
-
-
-@app.command('list | ls')
-def list(ctx: typer.Context):
-    """List all scenes."""
-    resp = ctx.obj.get_scene_list()
-    scenes = (
-        (scene.get('sceneName'), scene.get('sceneUuid'))
-        for scene in reversed(resp.scenes)
-    )
-
-    table = Table(title='Scenes', padding=(0, 2))
-    for column in ('Scene Name', 'UUID'):
-        table.add_column(column, justify='left', style='cyan')
-
-    for scene_name, scene_uuid in scenes:
-        table.add_row(
-            scene_name,
-            scene_uuid,
-        )
-
-    out_console.print(table)
-
-
-@app.command('current | get')
-def current(
-    ctx: typer.Context,
-    preview: Annotated[
-        bool, typer.Option(help='Get the preview scene instead of the program scene')
-    ] = False,
-):
-    """Get the current program scene or preview scene."""
-    if preview and not validate.studio_mode_enabled(ctx):
-        err_console.print('Studio mode is not enabled, cannot get preview scene.')
-        raise typer.Exit(1)
-
-    if preview:
-        resp = ctx.obj.get_current_preview_scene()
-        out_console.print(resp.current_preview_scene_name)
-    else:
-        resp = ctx.obj.get_current_program_scene()
-        out_console.print(resp.current_program_scene_name)
-
-
-@app.command('switch | set')
-def switch(
-    ctx: typer.Context,
-    scene_name: str,
-    preview: Annotated[
-        bool,
-        typer.Option(help='Switch to the preview scene instead of the program scene'),
-    ] = False,
-):
-    """Switch to a scene."""
-    if preview and not validate.studio_mode_enabled(ctx):
-        err_console.print('Studio mode is not enabled, cannot set the preview scene.')
-        raise typer.Exit(1)
-
-    if not validate.scene_in_scenes(ctx, scene_name):
-        err_console.print(f"Scene '{scene_name}' not found.")
-        raise typer.Exit(1)
-
-    if preview:
-        ctx.obj.set_current_preview_scene(scene_name)
-        out_console.print(f'Switched to preview scene: {scene_name}')
-    else:
-        ctx.obj.set_current_program_scene(scene_name)
-        out_console.print(f'Switched to program scene: {scene_name}')

obsws_cli/scenecollection.py

@@ -1,69 +0,0 @@
-"""module containing commands for manipulating scene collections."""
-
-import typer
-from rich.console import Console
-from rich.table import Table
-
-from . import validate
-from .alias import AliasGroup
-
-app = typer.Typer(cls=AliasGroup)
-out_console = Console()
-err_console = Console(stderr=True)
-
-
-@app.callback()
-def main():
-    """Control scene collections in OBS."""
-
-
-@app.command('list | ls')
-def list(ctx: typer.Context):
-    """List all scene collections."""
-    resp = ctx.obj.get_scene_collection_list()
-
-    table = Table(title='Scene Collections', padding=(0, 2))
-    table.add_column('Scene Collection Name', justify='left', style='cyan')
-
-    for scene_collection_name in resp.scene_collections:
-        table.add_row(scene_collection_name)
-
-    out_console.print(table)
-
-
-@app.command('current | get')
-def current(ctx: typer.Context):
-    """Get the current scene collection."""
-    resp = ctx.obj.get_scene_collection_list()
-    out_console.print(resp.current_scene_collection_name)
-
-
-@app.command('switch | set')
-def switch(ctx: typer.Context, scene_collection_name: str):
-    """Switch to a scene collection."""
-    if not validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
-        err_console.print(f"Scene collection '{scene_collection_name}' not found.")
-        raise typer.Exit(1)
-
-    current_scene_collection = (
-        ctx.obj.get_scene_collection_list().current_scene_collection_name
-    )
-    if scene_collection_name == current_scene_collection:
-        err_console.print(
-            f'Scene collection "{scene_collection_name}" is already active.'
-        )
-        raise typer.Exit(1)
-
-    ctx.obj.set_current_scene_collection(scene_collection_name)
-    out_console.print(f"Switched to scene collection '{scene_collection_name}'")
-
-
-@app.command('create | new')
-def create(ctx: typer.Context, scene_collection_name: str):
-    """Create a new scene collection."""
-    if validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
-        err_console.print(f"Scene collection '{scene_collection_name}' already exists.")
-        raise typer.Exit(1)
-
-    ctx.obj.create_scene_collection(scene_collection_name)
-    out_console.print(f'Created scene collection {scene_collection_name}')

obsws_cli/sceneitem.py

@@ -1,457 +0,0 @@
-"""module containing commands for manipulating items in scenes."""
-
-from collections.abc import Callable
-from typing import Annotated, Optional
-
-import obsws_python as obsws
-import typer
-from rich.console import Console
-from rich.table import Table
-
-from . import validate
-from .alias import AliasGroup
-
-app = typer.Typer(cls=AliasGroup)
-out_console = Console()
-err_console = Console(stderr=True)
-
-
-@app.callback()
-def main():
-    """Control items in OBS scenes."""
-
-
-@app.command('list | ls')
-def list(
-    ctx: typer.Context,
-    scene_name: str = typer.Argument(
-        None, help='Scene name (optional, defaults to current scene)'
-    ),
-):
-    """List all items in a scene."""
-    if not scene_name:
-        scene_name = ctx.obj.get_current_program_scene().scene_name
-
-    if not validate.scene_in_scenes(ctx, scene_name):
-        err_console.print(f"Scene '{scene_name}' not found.")
-        raise typer.Exit(1)
-
-    resp = ctx.obj.get_scene_item_list(scene_name)
-    items = sorted(
-        (
-            (
-                item.get('sceneItemId'),
-                item.get('sourceName'),
-                item.get('isGroup'),
-                item.get('sceneItemEnabled'),
-            )
-            for item in resp.scene_items
-        ),
-        key=lambda x: x[0],  # Sort by sceneItemId
-    )
-
-    if not items:
-        out_console.print(f"No items found in scene '{scene_name}'.")
-        raise typer.Exit()
-
-    table = Table(title=f'Items in Scene: {scene_name}', padding=(0, 2))
-    for column in ('Item ID', 'Item Name', 'In Group', 'Enabled'):
-        table.add_column(
-            column, justify='left' if column == 'Item Name' else 'center', style='cyan'
-        )
-
-    for item_id, item_name, is_group, is_enabled in items:
-        if is_group:
-            resp = ctx.obj.get_group_scene_item_list(item_name)
-            group_items = sorted(
-                (
-                    (
-                        gi.get('sceneItemId'),
-                        gi.get('sourceName'),
-                        gi.get('sceneItemEnabled'),
-                    )
-                    for gi in resp.scene_items
-                ),
-                key=lambda x: x[0],  # Sort by sceneItemId
-            )
-            for group_item_id, group_item_name, group_item_enabled in group_items:
-                table.add_row(
-                    str(group_item_id),
-                    group_item_name,
-                    item_name,
-                    ':white_heavy_check_mark:'
-                    if is_enabled and group_item_enabled
-                    else ':x:',
-                )
-        else:
-            table.add_row(
-                str(item_id),
-                item_name,
-                '',
-                ':white_heavy_check_mark:' if is_enabled else ':x:',
-            )
-
-    out_console.print(table)
-
-
-def _validate_scene_name_and_item_name(
-    func: Callable,
-):
-    """Validate the scene name and item name."""
-
-    def wrapper(
-        ctx: typer.Context,
-        scene_name: str,
-        item_name: str,
-        group: Optional[str] = None,
-    ):
-        if not validate.scene_in_scenes(ctx, scene_name):
-            err_console.print(f"Scene '{scene_name}' not found.")
-            raise typer.Exit(1)
-
-        if group:
-            if not validate.item_in_scene_item_list(ctx, scene_name, group):
-                err_console.print(
-                    f"Parent group '{group}' not found in scene '{scene_name}'."
-                )
-                raise typer.Exit(1)
-        else:
-            if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
-                err_console.print(
-                    f"Item '{item_name}' not found in scene '{scene_name}'."
-                )
-                raise typer.Exit(1)
-
-        return func(ctx, scene_name, item_name, group)
-
-    return wrapper
-
-
-def _get_scene_name_and_item_id(
-    ctx: typer.Context, scene_name: str, item_name: str, group: Optional[str] = None
-):
-    """Get the scene name and item ID for the given scene and item name."""
-    if group:
-        resp = ctx.obj.get_group_scene_item_list(group)
-        for item in resp.scene_items:
-            if item.get('sourceName') == item_name:
-                scene_name = group
-                scene_item_id = item.get('sceneItemId')
-                break
-        else:
-            err_console.print(f"Item '{item_name}' not found in group '{group}'.")
-            raise typer.Exit(1)
-    else:
-        try:
-            resp = ctx.obj.get_scene_item_id(scene_name, item_name)
-        except obsws.error.OBSSDKRequestError as e:
-            if e.code == 600:
-                err_console.print(
-                    f"Item '{item_name}' not found in scene '{scene_name}'. Is the item in a group? "
-                    'If so use the --group option to specify the parent group. '
-                    'See `obsws-cli sceneitem list` for a list of items in the scene.'
-                )
-                raise typer.Exit(1)
-            else:
-                raise
-        scene_item_id = resp.scene_item_id
-
-    return scene_name, scene_item_id
-
-
-@_validate_scene_name_and_item_name
-@app.command('show | sh')
-def show(
-    ctx: typer.Context,
-    scene_name: str,
-    item_name: str,
-    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
-):
-    """Show an item in a scene."""
-    scene_name, scene_item_id = _get_scene_name_and_item_id(
-        ctx, scene_name, item_name, group
-    )
-
-    ctx.obj.set_scene_item_enabled(
-        scene_name=scene_name,
-        item_id=int(scene_item_id),
-        enabled=True,
-    )
-
-    if group:
-        out_console.print(
-            f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been shown."
-        )
-    else:
-        # If not in a parent group, just show the scene name
-        # This is to avoid confusion with the parent group name
-        # which is not the same as the scene name
-        # and is not needed in this case
-        out_console.print(f"Item '{item_name}' in scene '{scene_name}' has been shown.")
-
-
-@_validate_scene_name_and_item_name
-@app.command('hide | h')
-def hide(
-    ctx: typer.Context,
-    scene_name: str,
-    item_name: str,
-    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
-):
-    """Hide an item in a scene."""
-    scene_name, scene_item_id = _get_scene_name_and_item_id(
-        ctx, scene_name, item_name, group
-    )
-
-    ctx.obj.set_scene_item_enabled(
-        scene_name=scene_name,
-        item_id=int(scene_item_id),
-        enabled=False,
-    )
-
-    if group:
-        out_console.print(
-            f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been hidden."
-        )
-    else:
-        # If not in a parent group, just show the scene name
-        # This is to avoid confusion with the parent group name
-        # which is not the same as the scene name
-        # and is not needed in this case
-        out_console.print(
-            f"Item '{item_name}' in scene '{scene_name}' has been hidden."
-        )
-
-
-@_validate_scene_name_and_item_name
-@app.command('toggle | tg')
-def toggle(
-    ctx: typer.Context,
-    scene_name: str,
-    item_name: str,
-    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
-):
-    """Toggle an item in a scene."""
-    if not validate.scene_in_scenes(ctx, scene_name):
-        err_console.print(f"Scene '{scene_name}' not found.")
-        raise typer.Exit(1)
-
-    if group:
-        if not validate.item_in_scene_item_list(ctx, scene_name, group):
-            err_console.print(
-                f"Parent group '{group}' not found in scene '{scene_name}'."
-            )
-            raise typer.Exit(1)
-    else:
-        if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
-            err_console.print(f"Item '{item_name}' not found in scene '{scene_name}'.")
-            raise typer.Exit(1)
-
-    scene_name, scene_item_id = _get_scene_name_and_item_id(
-        ctx, scene_name, item_name, group
-    )
-
-    enabled = ctx.obj.get_scene_item_enabled(
-        scene_name=scene_name,
-        item_id=int(scene_item_id),
-    )
-    new_state = not enabled.scene_item_enabled
-
-    ctx.obj.set_scene_item_enabled(
-        scene_name=scene_name,
-        item_id=int(scene_item_id),
-        enabled=new_state,
-    )
-
-    if group:
-        if new_state:
-            out_console.print(
-                f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been shown."
-            )
-        else:
-            out_console.print(
-                f"Item '{item_name}' in group '{group}' in scene '{scene_name}' has been hidden."
-            )
-    else:
-        # If not in a parent group, just show the scene name
-        # This is to avoid confusion with the parent group name
-        # which is not the same as the scene name
-        # and is not needed in this case
-        if new_state:
-            out_console.print(
-                f"Item '{item_name}' in scene '{scene_name}' has been shown."
-            )
-        else:
-            out_console.print(
-                f"Item '{item_name}' in scene '{scene_name}' has been hidden."
-            )
-
-
-@_validate_scene_name_and_item_name
-@app.command('visible | v')
-def visible(
-    ctx: typer.Context,
-    scene_name: str,
-    item_name: str,
-    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
-):
-    """Check if an item in a scene is visible."""
-    if group:
-        if not validate.item_in_scene_item_list(ctx, scene_name, group):
-            err_console.print(
-                f"Parent group '{group}' not found in scene '{scene_name}'."
-            )
-            raise typer.Exit(1)
-    else:
-        if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
-            err_console.print(f"Item '{item_name}' not found in scene '{scene_name}'.")
-            raise typer.Exit(1)
-
-    old_scene_name = scene_name
-    scene_name, scene_item_id = _get_scene_name_and_item_id(
-        ctx, scene_name, item_name, group
-    )
-
-    enabled = ctx.obj.get_scene_item_enabled(
-        scene_name=scene_name,
-        item_id=int(scene_item_id),
-    )
-
-    if group:
-        out_console.print(
-            f"Item '{item_name}' in group '{group}' in scene '{old_scene_name}' is currently {'visible' if enabled.scene_item_enabled else 'hidden'}."
-        )
-    else:
-        # If not in a parent group, just show the scene name
-        # This is to avoid confusion with the parent group name
-        # which is not the same as the scene name
-        # and is not needed in this case
-        out_console.print(
-            f"Item '{item_name}' in scene '{scene_name}' is currently {'visible' if enabled.scene_item_enabled else 'hidden'}."
-        )
-
-
-@_validate_scene_name_and_item_name
-@app.command('transform | t')
-def transform(
-    ctx: typer.Context,
-    scene_name: str,
-    item_name: str,
-    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
-    alignment: Annotated[
-        Optional[int], typer.Option(help='Alignment of the item in the scene')
-    ] = None,
-    bounds_alignment: Annotated[
-        Optional[int], typer.Option(help='Bounds alignment of the item in the scene')
-    ] = None,
-    bounds_height: Annotated[
-        Optional[float], typer.Option(help='Height of the item in the scene')
-    ] = None,
-    bounds_type: Annotated[
-        Optional[str], typer.Option(help='Type of bounds for the item in the scene')
-    ] = None,
-    bounds_width: Annotated[
-        Optional[float], typer.Option(help='Width of the item in the scene')
-    ] = None,
-    crop_to_bounds: Annotated[
-        Optional[bool], typer.Option(help='Crop the item to the bounds')
-    ] = None,
-    crop_bottom: Annotated[
-        Optional[float], typer.Option(help='Bottom crop of the item in the scene')
-    ] = None,
-    crop_left: Annotated[
-        Optional[float], typer.Option(help='Left crop of the item in the scene')
-    ] = None,
-    crop_right: Annotated[
-        Optional[float], typer.Option(help='Right crop of the item in the scene')
-    ] = None,
-    crop_top: Annotated[
-        Optional[float], typer.Option(help='Top crop of the item in the scene')
-    ] = None,
-    position_x: Annotated[
-        Optional[float], typer.Option(help='X position of the item in the scene')
-    ] = None,
-    position_y: Annotated[
-        Optional[float], typer.Option(help='Y position of the item in the scene')
-    ] = None,
-    rotation: Annotated[
-        Optional[float], typer.Option(help='Rotation of the item in the scene')
-    ] = None,
-    scale_x: Annotated[
-        Optional[float], typer.Option(help='X scale of the item in the scene')
-    ] = None,
-    scale_y: Annotated[
-        Optional[float], typer.Option(help='Y scale of the item in the scene')
-    ] = None,
-):
-    """Set the transform of an item in a scene."""
-    if group:
-        if not validate.item_in_scene_item_list(ctx, scene_name, group):
-            err_console.print(
-                f"Parent group '{group}' not found in scene '{scene_name}'."
-            )
-            raise typer.Exit(1)
-    else:
-        if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
-            err_console.print(f"Item '{item_name}' not found in scene '{scene_name}'.")
-            raise typer.Exit(1)
-
-    old_scene_name = scene_name
-    scene_name, scene_item_id = _get_scene_name_and_item_id(
-        ctx, scene_name, item_name, group
-    )
-
-    transform = {}
-    if alignment is not None:
-        transform['alignment'] = alignment
-    if bounds_alignment is not None:
-        transform['boundsAlignment'] = bounds_alignment
-    if bounds_height is not None:
-        transform['boundsHeight'] = bounds_height
-    if bounds_type is not None:
-        transform['boundsType'] = bounds_type
-    if bounds_width is not None:
-        transform['boundsWidth'] = bounds_width
-    if crop_to_bounds is not None:
-        transform['cropToBounds'] = crop_to_bounds
-    if crop_bottom is not None:
-        transform['cropBottom'] = crop_bottom
-    if crop_left is not None:
-        transform['cropLeft'] = crop_left
-    if crop_right is not None:
-        transform['cropRight'] = crop_right
-    if crop_top is not None:
-        transform['cropTop'] = crop_top
-    if position_x is not None:
-        transform['positionX'] = position_x
-    if position_y is not None:
-        transform['positionY'] = position_y
-    if rotation is not None:
-        transform['rotation'] = rotation
-    if scale_x is not None:
-        transform['scaleX'] = scale_x
-    if scale_y is not None:
-        transform['scaleY'] = scale_y
-
-    if not transform:
-        err_console.print('No transform options provided.')
-        raise typer.Exit(1)
-
-    transform = ctx.obj.set_scene_item_transform(
-        scene_name=scene_name,
-        item_id=int(scene_item_id),
-        transform=transform,
-    )
-
-    if group:
-        out_console.print(
-            f"Item '{item_name}' in group '{group}' in scene '{old_scene_name}' has been transformed."
-        )
-    else:
-        # If not in a parent group, just show the scene name
-        # This is to avoid confusion with the parent group name
-        # which is not the same as the scene name
-        # and is not needed in this case
-        out_console.print(
-            f"Item '{item_name}' in scene '{scene_name}' has been transformed."
-        )

obsws_cli/settings.py

@@ -1,31 +0,0 @@
-"""module for settings management."""
-
-from pathlib import Path
-
-from pydantic_settings import BaseSettings, SettingsConfigDict
-
-
-class Settings(BaseSettings):
-    """Settings for the OBS WebSocket client."""
-
-    model_config = SettingsConfigDict(
-        env_file=(
-            '.env',
-            Path.home() / '.config' / 'obsws-cli' / 'obsws.env',
-        ),
-        env_file_encoding='utf-8',
-        env_prefix='OBS_',
-    )
-
-    HOST: str = 'localhost'
-    PORT: int = 4455
-    PASSWORD: str = ''  # No password by default
-    TIMEOUT: int = 5  # Timeout for requests in seconds
-
-
-_settings = Settings().model_dump()
-
-
-def get(key: str) -> str:
-    """Get a setting by key."""
-    return _settings.get(key)

obsws_cli/studiomode.py

@@ -1,51 +0,0 @@
-"""module containing commands for manipulating studio mode in OBS."""
-
-import typer
-from rich.console import Console
-
-from .alias import AliasGroup
-
-app = typer.Typer(cls=AliasGroup)
-out_console = Console()
-err_console = Console(stderr=True)
-
-
-@app.callback()
-def main():
-    """Control studio mode in OBS."""
-
-
-@app.command('enable | on')
-def enable(ctx: typer.Context):
-    """Enable studio mode."""
-    ctx.obj.set_studio_mode_enabled(True)
-    out_console.print('Studio mode has been enabled.')
-
-
-@app.command('disable | off')
-def disable(ctx: typer.Context):
-    """Disable studio mode."""
-    ctx.obj.set_studio_mode_enabled(False)
-    out_console.print('Studio mode has been disabled.')
-
-
-@app.command('toggle | tg')
-def toggle(ctx: typer.Context):
-    """Toggle studio mode."""
-    resp = ctx.obj.get_studio_mode_enabled()
-    if resp.studio_mode_enabled:
-        ctx.obj.set_studio_mode_enabled(False)
-        out_console.print('Studio mode is now disabled.')
-    else:
-        ctx.obj.set_studio_mode_enabled(True)
-        out_console.print('Studio mode is now enabled.')
-
-
-@app.command('status | ss')
-def status(ctx: typer.Context):
-    """Get the status of studio mode."""
-    resp = ctx.obj.get_studio_mode_enabled()
-    if resp.studio_mode_enabled:
-        out_console.print('Studio mode is enabled.')
-    else:
-        out_console.print('Studio mode is disabled.')

obsws_cli/styles.py

@@ -0,0 +1,183 @@
+"""module containing styles for the OBS WebSocket CLI."""
+
+import os
+from dataclasses import dataclass
+
+registry = {}
+
+
+def register_style(cls):
+    """Register a style class."""
+    key = cls.__name__.lower()
+    if key in registry:
+        raise ValueError(f'Style {key} is already registered.')
+    registry[key] = cls
+    return cls
+
+
+@dataclass
+class Style:
+    """Base class for styles."""
+
+    name: str
+    border: str
+    column: str
+    highlight: str
+    no_border: bool = False
+
+    def __post_init__(self):
+        """Post-initialization to set default values and normalize the name."""
+        self.name = self.name.lower()
+        if self.no_border:
+            self.border = None
+
+
+@register_style
+@dataclass
+class Disabled(Style):
+    """Disabled style."""
+
+    name: str = 'disabled'
+    border: str = 'none'
+    column: str = 'none'
+    highlight: str = 'none'
+
+
+@register_style
+@dataclass
+class Red(Style):
+    """Red style."""
+
+    name: str = 'red'
+    border: str = 'red3'
+    column: str = 'red1'
+    highlight: str = 'red1'
+
+
+@register_style
+@dataclass
+class Magenta(Style):
+    """Magenta style."""
+
+    name: str = 'magenta'
+    border: str = 'magenta3'
+    column: str = 'orchid1'
+    highlight: str = 'orchid1'
+
+
+@register_style
+@dataclass
+class Purple(Style):
+    """Purple style."""
+
+    name: str = 'purple'
+    border: str = 'medium_purple4'
+    column: str = 'medium_purple'
+    highlight: str = 'medium_purple'
+
+
+@register_style
+@dataclass
+class Blue(Style):
+    """Blue style."""
+
+    name: str = 'blue'
+    border: str = 'cornflower_blue'
+    column: str = 'sky_blue2'
+    highlight: str = 'sky_blue2'
+
+
+@register_style
+@dataclass
+class Cyan(Style):
+    """Cyan style."""
+
+    name: str = 'cyan'
+    border: str = 'dark_cyan'
+    column: str = 'cyan'
+    highlight: str = 'cyan'
+
+
+@register_style
+@dataclass
+class Green(Style):
+    """Green style."""
+
+    name: str = 'green'
+    border: str = 'green4'
+    column: str = 'spring_green3'
+    highlight: str = 'spring_green3'
+
+
+@register_style
+@dataclass
+class Yellow(Style):
+    """Yellow style."""
+
+    name: str = 'yellow'
+    border: str = 'yellow3'
+    column: str = 'wheat1'
+    highlight: str = 'wheat1'
+
+
+@register_style
+@dataclass
+class Orange(Style):
+    """Orange style."""
+
+    name: str = 'orange'
+    border: str = 'dark_orange'
+    column: str = 'orange1'
+    highlight: str = 'orange1'
+
+
+@register_style
+@dataclass
+class White(Style):
+    """White style."""
+
+    name: str = 'white'
+    border: str = 'grey82'
+    column: str = 'grey100'
+    highlight: str = 'grey100'
+
+
+@register_style
+@dataclass
+class Grey(Style):
+    """Grey style."""
+
+    name: str = 'grey'
+    border: str = 'grey50'
+    column: str = 'grey70'
+    highlight: str = 'grey70'
+
+
+@register_style
+@dataclass
+class Navy(Style):
+    """Navy Blue style."""
+
+    name: str = 'navyblue'
+    border: str = 'deep_sky_blue4'
+    column: str = 'light_sky_blue3'
+    highlight: str = 'light_sky_blue3'
+
+
+@register_style
+@dataclass
+class Black(Style):
+    """Black style."""
+
+    name: str = 'black'
+    border: str = 'grey19'
+    column: str = 'grey11'
+    highlight: str = 'grey11'
+
+
+def request_style_obj(style_name: str, no_border: bool) -> Style:
+    """Entry point for style objects. Returns a Style object based on the style name."""
+    if style_name == 'disabled':
+        os.environ['NO_COLOR'] = '1'
+
+    return registry[style_name.lower()](no_border=no_border)

obsws_cli/util.py

@@ -1,6 +1,47 @@
 """module contains utility functions for the obsws_cli package."""
 
+import os
 
-def snakecase_to_titlecase(snake_str):
+
+def snakecase_to_titlecase(snake_str: str) -> str:
     """Convert a snake_case string to a title case string."""
     return snake_str.replace('_', ' ').title()
+
+
+def check_mark(value: bool, empty_if_false: bool = False) -> str:
+    """Return a check mark or cross mark based on the boolean value."""
+    if empty_if_false and not value:
+        return ''
+
+    # rich gracefully handles the absence of colour throughout the rest of the application,
+    # but here we must handle it manually.
+    # If NO_COLOR is set, we return plain text symbols.
+    # Otherwise, we return coloured symbols.
+    if os.getenv('NO_COLOR', '') != '':
+        return '✓' if value else '✗'
+    return '✅' if value else '❌'
+
+
+def timecode_to_milliseconds(timecode: str) -> int:
+    """Convert a timecode string (HH:MM:SS) to total milliseconds."""
+    match timecode.split(':'):
+        case [mm, ss]:
+            hours = 0
+            minutes = int(mm)
+            seconds = int(ss)
+        case [hh, mm, ss]:
+            hours = int(hh)
+            minutes = int(mm)
+            seconds = int(ss)
+    return (hours * 3600 + minutes * 60 + seconds) * 1000
+
+
+def milliseconds_to_timecode(milliseconds: int) -> str:
+    """Convert total milliseconds to a timecode string (HH:MM:SS)."""
+    total_seconds = milliseconds // 1000
+    hours = total_seconds // 3600
+    minutes = (total_seconds % 3600) // 60
+    seconds = total_seconds % 60
+    if hours == 0:
+        return f'{minutes:02}:{seconds:02}'
+    return f'{hours:02}:{minutes:02}:{seconds:02}'

obsws_cli/validate.py

@@ -1,48 +1,142 @@
 """module containing validation functions."""
 
+from typing import Optional
+
 import typer
 
+from . import console
+
 # type alias for an option that is skipped when the command is run
 skipped_option = typer.Option(parser=lambda _: _, hidden=True, expose_value=False)
 
 
-def input_in_inputs(ctx: typer.Context, input_name: str) -> bool:
-    """Check if an input is in the input list."""
-    inputs = ctx.obj.get_input_list().inputs
-    return any(input_.get('inputName') == input_name for input_ in inputs)
+def input_in_inputs(ctx: typer.Context, input_name: str) -> str:
+    """Ensure the given input exists in the list of inputs."""
+    resp = ctx.obj['obsws'].get_input_list()
+    if not any(input.get('inputName') == input_name for input in resp.inputs):
+        console.err.print(f'Input [yellow]{input_name}[/yellow] does not exist.')
+        raise typer.Exit(1)
+    return input_name
 
 
-def scene_in_scenes(ctx: typer.Context, scene_name: str) -> bool:
+def input_not_in_inputs(ctx: typer.Context, input_name: str) -> str:
+    """Ensure an input does not already exist in the list of inputs."""
+    resp = ctx.obj['obsws'].get_input_list()
+    if any(input.get('inputName') == input_name for input in resp.inputs):
+        console.err.print(f'Input [yellow]{input_name}[/yellow] already exists.')
+        raise typer.Exit(1)
+    return input_name
+
+
+def scene_in_scenes(ctx: typer.Context, scene_name: Optional[str]) -> str | None:
     """Check if a scene exists in the list of scenes."""
-    resp = ctx.obj.get_scene_list()
-    return any(scene.get('sceneName') == scene_name for scene in resp.scenes)
+    if scene_name is None:
+        return
+
+    resp = ctx.obj['obsws'].get_scene_list()
+    if not any(scene.get('sceneName') == scene_name for scene in resp.scenes):
+        console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
+        raise typer.Exit(1)
+    return scene_name
 
 
-def studio_mode_enabled(ctx: typer.Context) -> bool:
-    """Check if studio mode is enabled."""
-    resp = ctx.obj.get_studio_mode_enabled()
-    return resp.studio_mode_enabled
+def studio_mode_enabled(ctx: typer.Context, preview: bool) -> bool:
+    """Ensure studio mode is enabled if preview option is used."""
+    resp = ctx.obj['obsws'].get_studio_mode_enabled()
+    if preview and not resp.studio_mode_enabled:
+        console.err.print(
+            'Studio mode is disabled. This action requires it to be enabled.'
+        )
+        raise typer.Exit(1)
+    return preview
 
 
 def scene_collection_in_scene_collections(
     ctx: typer.Context, scene_collection_name: str
-) -> bool:
-    """Check if a scene collection exists."""
-    resp = ctx.obj.get_scene_collection_list()
-    return any(
+) -> str:
+    """Ensure a scene collection exists in the list of scene collections."""
+    resp = ctx.obj['obsws'].get_scene_collection_list()
+    if not any(
         collection == scene_collection_name for collection in resp.scene_collections
-    )
+    ):
+        console.err.print(
+            f'Scene collection [yellow]{scene_collection_name}[/yellow] not found.'
+        )
+        raise typer.Exit(1)
+    return scene_collection_name
+
+
+def scene_collection_not_in_scene_collections(
+    ctx: typer.Context, scene_collection_name: str
+) -> str:
+    """Ensure a scene collection does not already exist in the list of scene collections."""
+    resp = ctx.obj['obsws'].get_scene_collection_list()
+    if any(
+        collection == scene_collection_name for collection in resp.scene_collections
+    ):
+        console.err.print(
+            f'Scene collection [yellow]{scene_collection_name}[/yellow] already exists.'
+        )
+        raise typer.Exit(1)
+    return scene_collection_name
 
 
 def item_in_scene_item_list(
     ctx: typer.Context, scene_name: str, item_name: str
 ) -> bool:
     """Check if an item exists in a scene."""
-    resp = ctx.obj.get_scene_item_list(scene_name)
+    resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
     return any(item.get('sourceName') == item_name for item in resp.scene_items)
 
 
-def profile_exists(ctx: typer.Context, profile_name: str) -> bool:
-    """Check if a profile exists."""
-    resp = ctx.obj.get_profile_list()
-    return any(profile == profile_name for profile in resp.profiles)
+def profile_exists(ctx: typer.Context, profile_name: str) -> str:
+    """Ensure a profile exists."""
+    resp = ctx.obj['obsws'].get_profile_list()
+    if not any(profile == profile_name for profile in resp.profiles):
+        console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
+        raise typer.Exit(1)
+    return profile_name
+
+
+def profile_not_exists(ctx: typer.Context, profile_name: str) -> str:
+    """Ensure a profile does not exist."""
+    resp = ctx.obj['obsws'].get_profile_list()
+    if any(profile == profile_name for profile in resp.profiles):
+        console.err.print(f'Profile [yellow]{profile_name}[/yellow] already exists.')
+        raise typer.Exit(1)
+    return profile_name
+
+
+def kind_in_input_kinds(ctx: typer.Context, input_kind: str) -> str:
+    """Check if an input kind is valid."""
+    resp = ctx.obj['obsws'].get_input_kind_list(False)
+    if not any(kind == input_kind for kind in resp.input_kinds):
+        console.err.print(f'Input kind [yellow]{input_kind}[/yellow] not found.')
+        raise typer.Exit(1)
+    return input_kind
+
+
+def timecode_format(ctx: typer.Context, timecode: Optional[str]) -> str | None:
+    """Validate that a timecode is in HH:MM:SS or MM:SS format."""
+    if timecode is None:
+        return
+
+    match timecode.split(':'):
+        case [mm, ss]:
+            if not (mm.isdigit() and ss.isdigit()):
+                console.err.print(
+                    f'Timecode [yellow]{timecode}[/yellow] is not valid. Use MM:SS or HH:MM:SS format.'
+                )
+                raise typer.Exit(1)
+        case [hh, mm, ss]:
+            if not (hh.isdigit() and mm.isdigit() and ss.isdigit()):
+                console.err.print(
+                    f'Timecode [yellow]{timecode}[/yellow] is not valid. Use MM:SS or HH:MM:SS format.'
+                )
+                raise typer.Exit(1)
+        case _:
+            console.err.print(
+                f'Timecode [yellow]{timecode}[/yellow] is not valid. Use MM:SS or HH:MM:SS format.'
+            )
+            raise typer.Exit(1)
+    return timecode

obsws_cli/virtualcam.py

@@ -1,49 +0,0 @@
-"""module containing commands for manipulating virtual camera in OBS."""
-
-import typer
-from rich.console import Console
-
-from .alias import AliasGroup
-
-app = typer.Typer(cls=AliasGroup)
-out_console = Console()
-err_console = Console(stderr=True)
-
-
-@app.callback()
-def main():
-    """Control virtual camera in OBS."""
-
-
-@app.command('start | s')
-def start(ctx: typer.Context):
-    """Start the virtual camera."""
-    ctx.obj.start_virtual_cam()
-    out_console.print('Virtual camera started.')
-
-
-@app.command('stop | p')
-def stop(ctx: typer.Context):
-    """Stop the virtual camera."""
-    ctx.obj.stop_virtual_cam()
-    out_console.print('Virtual camera stopped.')
-
-
-@app.command('toggle | tg')
-def toggle(ctx: typer.Context):
-    """Toggle the virtual camera."""
-    resp = ctx.obj.toggle_virtual_cam()
-    if resp.output_active:
-        out_console.print('Virtual camera is enabled.')
-    else:
-        out_console.print('Virtual camera is disabled.')
-
-
-@app.command('status | ss')
-def status(ctx: typer.Context):
-    """Get the status of the virtual camera."""
-    resp = ctx.obj.get_virtual_cam_status()
-    if resp.output_active:
-        out_console.print('Virtual camera is enabled.')
-    else:
-        out_console.print('Virtual camera is disabled.')

pyproject.toml

@@ -21,11 +21,7 @@ classifiers = [
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
-dependencies = [
-  "typer>=0.16.0",
-  "obsws-python>=1.7.2",
-  "pydantic-settings>=2.9.1",
-]
+dependencies = ["typer>=0.24.1", "obsws-python>=1.8.0", "python-dotenv>=1.2.2"]
 
 
 [project.urls]
@@ -39,11 +35,18 @@ obsws-cli = "obsws_cli:app"
 [tool.hatch.version]
 path = "obsws_cli/__about__.py"
 
+[tool.hatch.env]
+requires = ["hatch-dotenv>=0.1.4"]
+
+[tool.hatch.env.collectors.dotenv.hatch-test]
+env-files = [".env", ".test.env"]
+fail-on-missing = true
+
 [tool.hatch.envs.default]
+workspace.members = [{ path = "../obsws-python" }]
 dependencies = ["click-man>=0.5.1"]
 
 [tool.hatch.envs.default.scripts]
-cli = "obsws-cli {args:}"
 man = "python man/generate.py --output=./man"
 
 [tool.hatch.envs.hatch-test]

tests/conftest.py

@@ -1,9 +1,9 @@
 """pytest configuration file."""
 
 import os
+import time
 
 import obsws_python as obsws
-from dotenv import find_dotenv, load_dotenv
 
 
 def pytest_configure(config):
@@ -20,9 +20,9 @@ def pytest_sessionstart(session):
     """
     # Initialize the OBS WebSocket client
     session.obsws = obsws.ReqClient(
-        host=os.environ['OBS_HOST'],
-        port=os.environ['OBS_PORT'],
-        password=os.environ['OBS_PASSWORD'],
+        host=os.environ['OBSWS_CLI_HOST'],
+        port=os.environ['OBSWS_CLI_PORT'],
+        password=os.environ['OBSWS_CLI_PASSWORD'],
         timeout=5,
     )
     resp = session.obsws.get_version()
@@ -33,20 +33,63 @@ def pytest_sessionstart(session):
     )
     print(' '.join(out))
 
-    load_dotenv(find_dotenv('.test.env'))
-
     session.obsws.set_stream_service_settings(
         'rtmp_common',
         {
             'service': 'Twitch',
             'server': 'auto',
-            'key': os.environ['OBS_STREAM_KEY'],
+            'key': os.environ['OBSWS_CLI_TESTS_STREAM_KEY'],
         },
     )
 
-    session.obsws.set_current_scene_collection('test-collection')
-
+    session.obsws.create_profile('pytest_profile')
+    time.sleep(0.1)  # Wait for the profile to be created
+    session.obsws.set_profile_parameter(
+        'SimpleOutput',
+        'RecRB',
+        'true',
+    )
+    # hack to ensure the replay buffer is enabled
+    session.obsws.set_current_profile('Untitled')
+    session.obsws.set_current_profile('pytest_profile')
     session.obsws.create_scene('pytest_scene')
+
+    # Ensure Desktop Audio is created.
+    desktop_audio_kinds = {
+        'windows': 'wasapi_output_capture',
+        'linux': 'pulse_output_capture',
+        'darwin': 'coreaudio_output_capture',
+    }
+    platform = os.environ['OBSWS_CLI_TESTS_PLATFORM']
+    try:
+        session.obsws.create_input(
+            sceneName='pytest_scene',
+            inputName='Desktop Audio',
+            inputKind=desktop_audio_kinds[platform],
+            inputSettings={'device_id': 'default'},
+            sceneItemEnabled=True,
+        )
+    except obsws.error.OBSSDKRequestError as e:
+        if e.code == 601:
+            """input already exists, continue."""
+    # Ensure Mic/Aux is created.
+    mic_kinds = {
+        'windows': 'wasapi_input_capture',
+        'linux': 'pulse_input_capture',
+        'darwin': 'coreaudio_input_capture',
+    }
+    try:
+        session.obsws.create_input(
+            sceneName='pytest_scene',
+            inputName='Mic/Aux',
+            inputKind=mic_kinds[platform],
+            inputSettings={'device_id': 'default'},
+            sceneItemEnabled=True,
+        )
+    except obsws.error.OBSSDKRequestError as e:
+        if e.code == 601:
+            """input already exists, continue."""
+
     session.obsws.create_input(
         sceneName='pytest_scene',
         inputName='pytest_input',
@@ -71,6 +114,13 @@ def pytest_sessionstart(session):
         },
         sceneItemEnabled=True,
     )
+    session.obsws.create_input(
+        sceneName='pytest_scene',
+        inputName='pytest_text_input',
+        inputKind='text_gdiplus_v3',
+        inputSettings={'text': 'Hello, OBS!'},
+        sceneItemEnabled=True,
+    )
     resp = session.obsws.get_scene_item_list('pytest_scene')
     for item in resp.scene_items:
         if item['sourceName'] == 'pytest_input_2':
@@ -124,7 +174,7 @@ def pytest_sessionfinish(session, exitstatus):
 
     session.obsws.remove_scene('pytest_scene')
 
-    session.obsws.set_current_scene_collection('default')
+    session.obsws.set_current_scene_collection('Untitled')
 
     resp = session.obsws.get_stream_status()
     if resp.output_active:
@@ -142,6 +192,8 @@ def pytest_sessionfinish(session, exitstatus):
     if resp.studio_mode_enabled:
         session.obsws.set_studio_mode_enabled(False)
 
+    session.obsws.remove_profile('pytest_profile')
+
     # Close the OBS WebSocket client connection
     session.obsws.disconnect()
 

tests/test_filter.py

@@ -4,7 +4,7 @@ from typer.testing import CliRunner
 
 from obsws_cli.app import app
 
-runner = CliRunner(mix_stderr=False)
+runner = CliRunner()
 
 
 def test_filter_list():
@@ -27,4 +27,4 @@ def test_filter_list_invalid_source():
     """Test the filter list command with an invalid source."""
     result = runner.invoke(app, ['filter', 'list', 'invalid_source'])
     assert result.exit_code != 0
-    assert "No source was found by the name of 'invalid_source'" in result.stderr
+    assert 'No source was found by the name of invalid_source' in result.stderr

tests/test_group.py

@@ -1,10 +1,18 @@
 """Unit tests for the group command in the OBS WebSocket CLI."""
 
+import os
+
+import pytest
 from typer.testing import CliRunner
 
 from obsws_cli.app import app
 
-runner = CliRunner(mix_stderr=False)
+runner = CliRunner()
+
+if os.environ.get('OBSWS_CLI_TESTS_SKIP_GROUP_TESTS'):
+    pytest.skip(
+        'Skipping group tests as per environment variable', allow_module_level=True
+    )
 
 
 def test_group_list():
@@ -18,29 +26,29 @@ def test_group_show():
     """Test the group show command."""
     result = runner.invoke(app, ['group', 'show', 'Scene', 'test_group'])
     assert result.exit_code == 0
-    assert "Group 'test_group' is now visible." in result.stdout
+    assert 'Group test_group is now visible.' in result.stdout
 
 
 def test_group_toggle():
     """Test the group toggle command."""
     result = runner.invoke(app, ['group', 'status', 'Scene', 'test_group'])
     assert result.exit_code == 0
-    enabled = "Group 'test_group' is now visible." in result.stdout
+    enabled = 'Group test_group is now visible.' in result.stdout
 
     result = runner.invoke(app, ['group', 'toggle', 'Scene', 'test_group'])
     assert result.exit_code == 0
     if enabled:
-        assert "Group 'test_group' is now hidden." in result.stdout
+        assert 'Group test_group is now hidden.' in result.stdout
     else:
-        assert "Group 'test_group' is now visible." in result.stdout
+        assert 'Group test_group is now visible.' in result.stdout
 
 
 def test_group_status():
     """Test the group status command."""
     result = runner.invoke(app, ['group', 'show', 'Scene', 'test_group'])
     assert result.exit_code == 0
-    assert "Group 'test_group' is now visible." in result.stdout
+    assert 'Group test_group is now visible.' in result.stdout
 
     result = runner.invoke(app, ['group', 'status', 'Scene', 'test_group'])
     assert result.exit_code == 0
-    assert "Group 'test_group' is now visible." in result.stdout
+    assert 'Group test_group is now visible.' in result.stdout

tests/test_hotkey.py

@@ -4,7 +4,7 @@ from typer.testing import CliRunner
 
 from obsws_cli.app import app
 
-runner = CliRunner(mix_stderr=False)
+runner = CliRunner()
 
 
 def test_hotkey_list():

tests/test_input.py

@@ -4,7 +4,7 @@ from typer.testing import CliRunner
 
 from obsws_cli.app import app
 
-runner = CliRunner(mix_stderr=False)
+runner = CliRunner()
 
 
 def test_input_list():
@@ -13,10 +13,7 @@ def test_input_list():
     assert result.exit_code == 0
     assert 'Desktop Audio' in result.stdout
     assert 'Mic/Aux' in result.stdout
-    assert all(
-        item in result.stdout
-        for item in ('Colour Source', 'Colour Source 2', 'Colour Source 3')
-    )
+    assert all(item in result.stdout for item in ('pytest_input', 'pytest_input_2'))
 
 
 def test_input_list_filter_input():
@@ -39,9 +36,6 @@ def test_input_list_filter_colour():
     """Test the input list command with colour filter."""
     result = runner.invoke(app, ['input', 'list', '--colour'])
     assert result.exit_code == 0
-    assert all(
-        item in result.stdout
-        for item in ('Colour Source', 'Colour Source 2', 'Colour Source 3')
-    )
+    assert all(item in result.stdout for item in ('pytest_input', 'pytest_input_2'))
     assert 'Desktop Audio' not in result.stdout
     assert 'Mic/Aux' not in result.stdout

tests/test_record.py

@@ -6,7 +6,7 @@ from typer.testing import CliRunner
 
 from obsws_cli.app import app
 
-runner = CliRunner(mix_stderr=False)
+runner = CliRunner()
 
 
 def test_record_start():
@@ -49,7 +49,9 @@ def test_record_toggle():
 
     result = runner.invoke(app, ['record', 'toggle'])
     assert result.exit_code == 0
+
     time.sleep(0.5)  # Wait for the recording to toggle
+
     if active:
         assert 'Recording stopped successfully.' in result.stdout
     else:

tests/test_replaybuffer.py

@@ -1,10 +1,20 @@
 """Unit tests for the replaybuffer command in the OBS WebSocket CLI."""
 
+import os
+import time
+
+import pytest
 from typer.testing import CliRunner
 
 from obsws_cli.app import app
 
-runner = CliRunner(mix_stderr=False)
+runner = CliRunner()
+
+if os.environ.get('OBS_TESTS_SKIP_REPLAYBUFFER_TESTS'):
+    pytest.skip(
+        'Skipping replaybuffer tests as per environment variable',
+        allow_module_level=True,
+    )
 
 
 def test_replaybuffer_start():
@@ -14,6 +24,9 @@ def test_replaybuffer_start():
     active = 'Replay buffer is active.' in resp.stdout
 
     resp = runner.invoke(app, ['replaybuffer', 'start'])
+
+    time.sleep(0.5)  # Wait for the replay buffer to start
+
     if active:
         assert resp.exit_code != 0
         assert 'Replay buffer is already active.' in resp.stderr
@@ -29,6 +42,9 @@ def test_replaybuffer_stop():
     active = 'Replay buffer is active.' in resp.stdout
 
     resp = runner.invoke(app, ['replaybuffer', 'stop'])
+
+    time.sleep(0.5)  # Wait for the replay buffer to stop
+
     if not active:
         assert resp.exit_code != 0
         assert 'Replay buffer is not active.' in resp.stderr
@@ -44,9 +60,11 @@ def test_replaybuffer_toggle():
     active = 'Replay buffer is active.' in resp.stdout
 
     resp = runner.invoke(app, ['replaybuffer', 'toggle'])
+    assert resp.exit_code == 0
+
+    time.sleep(0.5)  # Wait for the replay buffer to toggle
+
     if active:
-        assert resp.exit_code == 0
         assert 'Replay buffer is not active.' in resp.stdout
     else:
-        assert resp.exit_code == 0
         assert 'Replay buffer is active.' in resp.stdout

tests/test_scene.py

@@ -4,7 +4,7 @@ from typer.testing import CliRunner
 
 from obsws_cli.app import app
 
-runner = CliRunner(mix_stderr=False)
+runner = CliRunner()
 
 
 def test_scene_list():
@@ -36,3 +36,10 @@ def test_scene_switch():
         result = runner.invoke(app, ['scene', 'switch', 'pytest_scene'])
         assert result.exit_code == 0
         assert 'Switched to program scene: pytest_scene' in result.stdout
+
+
+def test_scene_switch_invalid():
+    """Test the scene switch command with an invalid scene."""
+    result = runner.invoke(app, ['scene', 'switch', 'non_existent_scene'])
+    assert result.exit_code != 0
+    assert 'Scene non_existent_scene not found' in result.stderr

tests/test_sceneitem.py

@@ -4,7 +4,7 @@ from typer.testing import CliRunner
 
 from obsws_cli.app import app
 
-runner = CliRunner(mix_stderr=False)
+runner = CliRunner()
 
 
 def test_sceneitem_list():
@@ -29,6 +29,6 @@ def test_sceneitem_transform():
     )
     assert result.exit_code == 0
     assert (
-        "Item 'pytest_input_2' in scene 'pytest_scene' has been transformed"
+        'Item pytest_input_2 in scene pytest_scene has been transformed'
         in result.stdout
     )

tests/test_stream.py

@@ -6,7 +6,7 @@ from typer.testing import CliRunner
 
 from obsws_cli.app import app
 
-runner = CliRunner(mix_stderr=False)
+runner = CliRunner()
 
 
 def test_stream_start():
@@ -23,7 +23,7 @@ def test_stream_start():
     else:
         assert result.exit_code == 0
         assert 'Streaming started successfully.' in result.stdout
-        time.sleep(1)  # Wait for the streaming to start
+        time.sleep(0.5)  # Wait for the streaming to start
 
 
 def test_stream_stop():
@@ -37,7 +37,7 @@ def test_stream_stop():
     if active:
         assert result.exit_code == 0
         assert 'Streaming stopped successfully.' in result.stdout
-        time.sleep(1)  # Wait for the streaming to stop
+        time.sleep(0.5)  # Wait for the streaming to stop
     else:
         assert result.exit_code != 0
         assert 'Streaming is not in progress, cannot stop.' in result.stderr
@@ -52,7 +52,7 @@ def test_stream_toggle():
     result = runner.invoke(app, ['stream', 'toggle'])
     assert result.exit_code == 0
 
-    time.sleep(1)  # Wait for the stream to toggle
+    time.sleep(0.5)  # Wait for the stream to toggle
 
     if active:
         assert 'Streaming stopped successfully.' in result.stdout

tests/test_studiomode.py

@@ -4,7 +4,7 @@ from typer.testing import CliRunner
 
 from obsws_cli.app import app
 
-runner = CliRunner(mix_stderr=False)
+runner = CliRunner()
 
 
 def test_studio_enable():

tests/test_text.py

@@ -0,0 +1,18 @@
+"""Unit tests for the text command in the OBS WebSocket CLI."""
+
+from typer.testing import CliRunner
+
+from obsws_cli.app import app
+
+runner = CliRunner()
+
+
+def test_text_update():
+    """Test the text update command."""
+    result = runner.invoke(app, ['text', 'current', 'pytest_text_input'])
+    assert result.exit_code == 0
+    assert 'Current text for input pytest_text_input: Hello, OBS!' in result.stdout
+
+    result = runner.invoke(app, ['text', 'update', 'pytest_text_input', 'New Text'])
+    assert result.exit_code == 0
+    assert 'Text for input pytest_text_input updated to: New Text' in result.stdout

tests/test_version.py

@@ -4,14 +4,14 @@ from typer.testing import CliRunner
 
 from obsws_cli.app import app
 
-runner = CliRunner(mix_stderr=False)
+runner = CliRunner()
 
 
 def test_version():
     """Test the version option."""
     result = runner.invoke(app, ['--version'])
     assert result.exit_code == 0
-    assert 'obsws_cli version:' in result.stdout
+    assert 'obsws-cli version:' in result.stdout
 
 
 def test_obs_version():

uv.lock

@@ -2,15 +2,6 @@ version = 1
 revision = 2
 requires-python = ">=3.10"
 
-[[package]]
-name = "annotated-types"
-version = "0.7.0"
-source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/ee/67/531ea369ba64dcff5ec9c3402f9f51bf748cec26dde048a2f973a4eea7f5/annotated_types-0.7.0.tar.gz", hash = "sha256:aff07c09a53a08bc8cfccb9c85b05f1aa9a2a6f23728d790723543408344ce89", size = 16081, upload-time = "2024-05-20T21:33:25.928Z" }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/78/b6/6307fbef88d9b5ee7421e68d78a9f162e0da4900bc5f5793f6d3d0e34fb8/annotated_types-0.7.0-py3-none-any.whl", hash = "sha256:1f02e8b43a8fbbc3f3e0d4f0f4bfc8131bcb4eebe8849b8e5c773f3a1c582a53", size = 13643, upload-time = "2024-05-20T21:33:24.1Z" },
-]
-
 [[package]]
 name = "click"
 version = "8.1.8"
@@ -58,15 +49,15 @@ name = "obsws-cli"
 source = { editable = "." }
 dependencies = [
     { name = "obsws-python" },
-    { name = "pydantic-settings" },
+    { name = "python-dotenv" },
     { name = "typer" },
 ]
 
 [package.metadata]
 requires-dist = [
     { name = "obsws-python", specifier = ">=1.7.2" },
-    { name = "pydantic-settings", specifier = ">=2.9.1" },
-    { name = "typer", specifier = ">=0.15.2" },
+    { name = "python-dotenv", specifier = ">=1.1.0" },
+    { name = "typer", specifier = ">=0.16.0" },
 ]
 
 [[package]]
@@ -82,122 +73,6 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/7d/68/a5d63428b26221e0f6cb3968d93ffb951825ba0f82b23d356efedfa19fd5/obsws_python-1.7.2-py3-none-any.whl", hash = "sha256:acda31852ad9d7165de915b0603c13f6df527d3f61619970bf5fb562e300bc85", size = 30863, upload-time = "2025-05-14T19:20:24.603Z" },
 ]
 
-[[package]]
-name = "pydantic"
-version = "2.11.5"
-source = { registry = "https://pypi.org/simple" }
-dependencies = [
-    { name = "annotated-types" },
-    { name = "pydantic-core" },
-    { name = "typing-extensions" },
-    { name = "typing-inspection" },
-]
-sdist = { url = "https://files.pythonhosted.org/packages/f0/86/8ce9040065e8f924d642c58e4a344e33163a07f6b57f836d0d734e0ad3fb/pydantic-2.11.5.tar.gz", hash = "sha256:7f853db3d0ce78ce8bbb148c401c2cdd6431b3473c0cdff2755c7690952a7b7a", size = 787102, upload-time = "2025-05-22T21:18:08.761Z" }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/b5/69/831ed22b38ff9b4b64b66569f0e5b7b97cf3638346eb95a2147fdb49ad5f/pydantic-2.11.5-py3-none-any.whl", hash = "sha256:f9c26ba06f9747749ca1e5c94d6a85cb84254577553c8785576fd38fa64dc0f7", size = 444229, upload-time = "2025-05-22T21:18:06.329Z" },
-]
-
-[[package]]
-name = "pydantic-core"
-version = "2.33.2"
-source = { registry = "https://pypi.org/simple" }
-dependencies = [
-    { name = "typing-extensions" },
-]
-sdist = { url = "https://files.pythonhosted.org/packages/ad/88/5f2260bdfae97aabf98f1778d43f69574390ad787afb646292a638c923d4/pydantic_core-2.33.2.tar.gz", hash = "sha256:7cb8bc3605c29176e1b105350d2e6474142d7c1bd1d9327c4a9bdb46bf827acc", size = 435195, upload-time = "2025-04-23T18:33:52.104Z" }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/e5/92/b31726561b5dae176c2d2c2dc43a9c5bfba5d32f96f8b4c0a600dd492447/pydantic_core-2.33.2-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:2b3d326aaef0c0399d9afffeb6367d5e26ddc24d351dbc9c636840ac355dc5d8", size = 2028817, upload-time = "2025-04-23T18:30:43.919Z" },
-    { url = "https://files.pythonhosted.org/packages/a3/44/3f0b95fafdaca04a483c4e685fe437c6891001bf3ce8b2fded82b9ea3aa1/pydantic_core-2.33.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:0e5b2671f05ba48b94cb90ce55d8bdcaaedb8ba00cc5359f6810fc918713983d", size = 1861357, upload-time = "2025-04-23T18:30:46.372Z" },
-    { url = "https://files.pythonhosted.org/packages/30/97/e8f13b55766234caae05372826e8e4b3b96e7b248be3157f53237682e43c/pydantic_core-2.33.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0069c9acc3f3981b9ff4cdfaf088e98d83440a4c7ea1bc07460af3d4dc22e72d", size = 1898011, upload-time = "2025-04-23T18:30:47.591Z" },
-    { url = "https://files.pythonhosted.org/packages/9b/a3/99c48cf7bafc991cc3ee66fd544c0aae8dc907b752f1dad2d79b1b5a471f/pydantic_core-2.33.2-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d53b22f2032c42eaaf025f7c40c2e3b94568ae077a606f006d206a463bc69572", size = 1982730, upload-time = "2025-04-23T18:30:49.328Z" },
-    { url = "https://files.pythonhosted.org/packages/de/8e/a5b882ec4307010a840fb8b58bd9bf65d1840c92eae7534c7441709bf54b/pydantic_core-2.33.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:0405262705a123b7ce9f0b92f123334d67b70fd1f20a9372b907ce1080c7ba02", size = 2136178, upload-time = "2025-04-23T18:30:50.907Z" },
-    { url = "https://files.pythonhosted.org/packages/e4/bb/71e35fc3ed05af6834e890edb75968e2802fe98778971ab5cba20a162315/pydantic_core-2.33.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4b25d91e288e2c4e0662b8038a28c6a07eaac3e196cfc4ff69de4ea3db992a1b", size = 2736462, upload-time = "2025-04-23T18:30:52.083Z" },
-    { url = "https://files.pythonhosted.org/packages/31/0d/c8f7593e6bc7066289bbc366f2235701dcbebcd1ff0ef8e64f6f239fb47d/pydantic_core-2.33.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6bdfe4b3789761f3bcb4b1ddf33355a71079858958e3a552f16d5af19768fef2", size = 2005652, upload-time = "2025-04-23T18:30:53.389Z" },
-    { url = "https://files.pythonhosted.org/packages/d2/7a/996d8bd75f3eda405e3dd219ff5ff0a283cd8e34add39d8ef9157e722867/pydantic_core-2.33.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:efec8db3266b76ef9607c2c4c419bdb06bf335ae433b80816089ea7585816f6a", size = 2113306, upload-time = "2025-04-23T18:30:54.661Z" },
-    { url = "https://files.pythonhosted.org/packages/ff/84/daf2a6fb2db40ffda6578a7e8c5a6e9c8affb251a05c233ae37098118788/pydantic_core-2.33.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:031c57d67ca86902726e0fae2214ce6770bbe2f710dc33063187a68744a5ecac", size = 2073720, upload-time = "2025-04-23T18:30:56.11Z" },
-    { url = "https://files.pythonhosted.org/packages/77/fb/2258da019f4825128445ae79456a5499c032b55849dbd5bed78c95ccf163/pydantic_core-2.33.2-cp310-cp310-musllinux_1_1_armv7l.whl", hash = "sha256:f8de619080e944347f5f20de29a975c2d815d9ddd8be9b9b7268e2e3ef68605a", size = 2244915, upload-time = "2025-04-23T18:30:57.501Z" },
-    { url = "https://files.pythonhosted.org/packages/d8/7a/925ff73756031289468326e355b6fa8316960d0d65f8b5d6b3a3e7866de7/pydantic_core-2.33.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:73662edf539e72a9440129f231ed3757faab89630d291b784ca99237fb94db2b", size = 2241884, upload-time = "2025-04-23T18:30:58.867Z" },
-    { url = "https://files.pythonhosted.org/packages/0b/b0/249ee6d2646f1cdadcb813805fe76265745c4010cf20a8eba7b0e639d9b2/pydantic_core-2.33.2-cp310-cp310-win32.whl", hash = "sha256:0a39979dcbb70998b0e505fb1556a1d550a0781463ce84ebf915ba293ccb7e22", size = 1910496, upload-time = "2025-04-23T18:31:00.078Z" },
-    { url = "https://files.pythonhosted.org/packages/66/ff/172ba8f12a42d4b552917aa65d1f2328990d3ccfc01d5b7c943ec084299f/pydantic_core-2.33.2-cp310-cp310-win_amd64.whl", hash = "sha256:b0379a2b24882fef529ec3b4987cb5d003b9cda32256024e6fe1586ac45fc640", size = 1955019, upload-time = "2025-04-23T18:31:01.335Z" },
-    { url = "https://files.pythonhosted.org/packages/3f/8d/71db63483d518cbbf290261a1fc2839d17ff89fce7089e08cad07ccfce67/pydantic_core-2.33.2-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:4c5b0a576fb381edd6d27f0a85915c6daf2f8138dc5c267a57c08a62900758c7", size = 2028584, upload-time = "2025-04-23T18:31:03.106Z" },
-    { url = "https://files.pythonhosted.org/packages/24/2f/3cfa7244ae292dd850989f328722d2aef313f74ffc471184dc509e1e4e5a/pydantic_core-2.33.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:e799c050df38a639db758c617ec771fd8fb7a5f8eaaa4b27b101f266b216a246", size = 1855071, upload-time = "2025-04-23T18:31:04.621Z" },
-    { url = "https://files.pythonhosted.org/packages/b3/d3/4ae42d33f5e3f50dd467761304be2fa0a9417fbf09735bc2cce003480f2a/pydantic_core-2.33.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dc46a01bf8d62f227d5ecee74178ffc448ff4e5197c756331f71efcc66dc980f", size = 1897823, upload-time = "2025-04-23T18:31:06.377Z" },
-    { url = "https://files.pythonhosted.org/packages/f4/f3/aa5976e8352b7695ff808599794b1fba2a9ae2ee954a3426855935799488/pydantic_core-2.33.2-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:a144d4f717285c6d9234a66778059f33a89096dfb9b39117663fd8413d582dcc", size = 1983792, upload-time = "2025-04-23T18:31:07.93Z" },
-    { url = "https://files.pythonhosted.org/packages/d5/7a/cda9b5a23c552037717f2b2a5257e9b2bfe45e687386df9591eff7b46d28/pydantic_core-2.33.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:73cf6373c21bc80b2e0dc88444f41ae60b2f070ed02095754eb5a01df12256de", size = 2136338, upload-time = "2025-04-23T18:31:09.283Z" },
-    { url = "https://files.pythonhosted.org/packages/2b/9f/b8f9ec8dd1417eb9da784e91e1667d58a2a4a7b7b34cf4af765ef663a7e5/pydantic_core-2.33.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3dc625f4aa79713512d1976fe9f0bc99f706a9dee21dfd1810b4bbbf228d0e8a", size = 2730998, upload-time = "2025-04-23T18:31:11.7Z" },
-    { url = "https://files.pythonhosted.org/packages/47/bc/cd720e078576bdb8255d5032c5d63ee5c0bf4b7173dd955185a1d658c456/pydantic_core-2.33.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:881b21b5549499972441da4758d662aeea93f1923f953e9cbaff14b8b9565aef", size = 2003200, upload-time = "2025-04-23T18:31:13.536Z" },
-    { url = "https://files.pythonhosted.org/packages/ca/22/3602b895ee2cd29d11a2b349372446ae9727c32e78a94b3d588a40fdf187/pydantic_core-2.33.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:bdc25f3681f7b78572699569514036afe3c243bc3059d3942624e936ec93450e", size = 2113890, upload-time = "2025-04-23T18:31:15.011Z" },
-    { url = "https://files.pythonhosted.org/packages/ff/e6/e3c5908c03cf00d629eb38393a98fccc38ee0ce8ecce32f69fc7d7b558a7/pydantic_core-2.33.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:fe5b32187cbc0c862ee201ad66c30cf218e5ed468ec8dc1cf49dec66e160cc4d", size = 2073359, upload-time = "2025-04-23T18:31:16.393Z" },
-    { url = "https://files.pythonhosted.org/packages/12/e7/6a36a07c59ebefc8777d1ffdaf5ae71b06b21952582e4b07eba88a421c79/pydantic_core-2.33.2-cp311-cp311-musllinux_1_1_armv7l.whl", hash = "sha256:bc7aee6f634a6f4a95676fcb5d6559a2c2a390330098dba5e5a5f28a2e4ada30", size = 2245883, upload-time = "2025-04-23T18:31:17.892Z" },
-    { url = "https://files.pythonhosted.org/packages/16/3f/59b3187aaa6cc0c1e6616e8045b284de2b6a87b027cce2ffcea073adf1d2/pydantic_core-2.33.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:235f45e5dbcccf6bd99f9f472858849f73d11120d76ea8707115415f8e5ebebf", size = 2241074, upload-time = "2025-04-23T18:31:19.205Z" },
-    { url = "https://files.pythonhosted.org/packages/e0/ed/55532bb88f674d5d8f67ab121a2a13c385df382de2a1677f30ad385f7438/pydantic_core-2.33.2-cp311-cp311-win32.whl", hash = "sha256:6368900c2d3ef09b69cb0b913f9f8263b03786e5b2a387706c5afb66800efd51", size = 1910538, upload-time = "2025-04-23T18:31:20.541Z" },
-    { url = "https://files.pythonhosted.org/packages/fe/1b/25b7cccd4519c0b23c2dd636ad39d381abf113085ce4f7bec2b0dc755eb1/pydantic_core-2.33.2-cp311-cp311-win_amd64.whl", hash = "sha256:1e063337ef9e9820c77acc768546325ebe04ee38b08703244c1309cccc4f1bab", size = 1952909, upload-time = "2025-04-23T18:31:22.371Z" },
-    { url = "https://files.pythonhosted.org/packages/49/a9/d809358e49126438055884c4366a1f6227f0f84f635a9014e2deb9b9de54/pydantic_core-2.33.2-cp311-cp311-win_arm64.whl", hash = "sha256:6b99022f1d19bc32a4c2a0d544fc9a76e3be90f0b3f4af413f87d38749300e65", size = 1897786, upload-time = "2025-04-23T18:31:24.161Z" },
-    { url = "https://files.pythonhosted.org/packages/18/8a/2b41c97f554ec8c71f2a8a5f85cb56a8b0956addfe8b0efb5b3d77e8bdc3/pydantic_core-2.33.2-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:a7ec89dc587667f22b6a0b6579c249fca9026ce7c333fc142ba42411fa243cdc", size = 2009000, upload-time = "2025-04-23T18:31:25.863Z" },
-    { url = "https://files.pythonhosted.org/packages/a1/02/6224312aacb3c8ecbaa959897af57181fb6cf3a3d7917fd44d0f2917e6f2/pydantic_core-2.33.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:3c6db6e52c6d70aa0d00d45cdb9b40f0433b96380071ea80b09277dba021ddf7", size = 1847996, upload-time = "2025-04-23T18:31:27.341Z" },
-    { url = "https://files.pythonhosted.org/packages/d6/46/6dcdf084a523dbe0a0be59d054734b86a981726f221f4562aed313dbcb49/pydantic_core-2.33.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4e61206137cbc65e6d5256e1166f88331d3b6238e082d9f74613b9b765fb9025", size = 1880957, upload-time = "2025-04-23T18:31:28.956Z" },
-    { url = "https://files.pythonhosted.org/packages/ec/6b/1ec2c03837ac00886ba8160ce041ce4e325b41d06a034adbef11339ae422/pydantic_core-2.33.2-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:eb8c529b2819c37140eb51b914153063d27ed88e3bdc31b71198a198e921e011", size = 1964199, upload-time = "2025-04-23T18:31:31.025Z" },
-    { url = "https://files.pythonhosted.org/packages/2d/1d/6bf34d6adb9debd9136bd197ca72642203ce9aaaa85cfcbfcf20f9696e83/pydantic_core-2.33.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c52b02ad8b4e2cf14ca7b3d918f3eb0ee91e63b3167c32591e57c4317e134f8f", size = 2120296, upload-time = "2025-04-23T18:31:32.514Z" },
-    { url = "https://files.pythonhosted.org/packages/e0/94/2bd0aaf5a591e974b32a9f7123f16637776c304471a0ab33cf263cf5591a/pydantic_core-2.33.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:96081f1605125ba0855dfda83f6f3df5ec90c61195421ba72223de35ccfb2f88", size = 2676109, upload-time = "2025-04-23T18:31:33.958Z" },
-    { url = "https://files.pythonhosted.org/packages/f9/41/4b043778cf9c4285d59742281a769eac371b9e47e35f98ad321349cc5d61/pydantic_core-2.33.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8f57a69461af2a5fa6e6bbd7a5f60d3b7e6cebb687f55106933188e79ad155c1", size = 2002028, upload-time = "2025-04-23T18:31:39.095Z" },
-    { url = "https://files.pythonhosted.org/packages/cb/d5/7bb781bf2748ce3d03af04d5c969fa1308880e1dca35a9bd94e1a96a922e/pydantic_core-2.33.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:572c7e6c8bb4774d2ac88929e3d1f12bc45714ae5ee6d9a788a9fb35e60bb04b", size = 2100044, upload-time = "2025-04-23T18:31:41.034Z" },
-    { url = "https://files.pythonhosted.org/packages/fe/36/def5e53e1eb0ad896785702a5bbfd25eed546cdcf4087ad285021a90ed53/pydantic_core-2.33.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:db4b41f9bd95fbe5acd76d89920336ba96f03e149097365afe1cb092fceb89a1", size = 2058881, upload-time = "2025-04-23T18:31:42.757Z" },
-    { url = "https://files.pythonhosted.org/packages/01/6c/57f8d70b2ee57fc3dc8b9610315949837fa8c11d86927b9bb044f8705419/pydantic_core-2.33.2-cp312-cp312-musllinux_1_1_armv7l.whl", hash = "sha256:fa854f5cf7e33842a892e5c73f45327760bc7bc516339fda888c75ae60edaeb6", size = 2227034, upload-time = "2025-04-23T18:31:44.304Z" },
-    { url = "https://files.pythonhosted.org/packages/27/b9/9c17f0396a82b3d5cbea4c24d742083422639e7bb1d5bf600e12cb176a13/pydantic_core-2.33.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:5f483cfb75ff703095c59e365360cb73e00185e01aaea067cd19acffd2ab20ea", size = 2234187, upload-time = "2025-04-23T18:31:45.891Z" },
-    { url = "https://files.pythonhosted.org/packages/b0/6a/adf5734ffd52bf86d865093ad70b2ce543415e0e356f6cacabbc0d9ad910/pydantic_core-2.33.2-cp312-cp312-win32.whl", hash = "sha256:9cb1da0f5a471435a7bc7e439b8a728e8b61e59784b2af70d7c169f8dd8ae290", size = 1892628, upload-time = "2025-04-23T18:31:47.819Z" },
-    { url = "https://files.pythonhosted.org/packages/43/e4/5479fecb3606c1368d496a825d8411e126133c41224c1e7238be58b87d7e/pydantic_core-2.33.2-cp312-cp312-win_amd64.whl", hash = "sha256:f941635f2a3d96b2973e867144fde513665c87f13fe0e193c158ac51bfaaa7b2", size = 1955866, upload-time = "2025-04-23T18:31:49.635Z" },
-    { url = "https://files.pythonhosted.org/packages/0d/24/8b11e8b3e2be9dd82df4b11408a67c61bb4dc4f8e11b5b0fc888b38118b5/pydantic_core-2.33.2-cp312-cp312-win_arm64.whl", hash = "sha256:cca3868ddfaccfbc4bfb1d608e2ccaaebe0ae628e1416aeb9c4d88c001bb45ab", size = 1888894, upload-time = "2025-04-23T18:31:51.609Z" },
-    { url = "https://files.pythonhosted.org/packages/46/8c/99040727b41f56616573a28771b1bfa08a3d3fe74d3d513f01251f79f172/pydantic_core-2.33.2-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:1082dd3e2d7109ad8b7da48e1d4710c8d06c253cbc4a27c1cff4fbcaa97a9e3f", size = 2015688, upload-time = "2025-04-23T18:31:53.175Z" },
-    { url = "https://files.pythonhosted.org/packages/3a/cc/5999d1eb705a6cefc31f0b4a90e9f7fc400539b1a1030529700cc1b51838/pydantic_core-2.33.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:f517ca031dfc037a9c07e748cefd8d96235088b83b4f4ba8939105d20fa1dcd6", size = 1844808, upload-time = "2025-04-23T18:31:54.79Z" },
-    { url = "https://files.pythonhosted.org/packages/6f/5e/a0a7b8885c98889a18b6e376f344da1ef323d270b44edf8174d6bce4d622/pydantic_core-2.33.2-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0a9f2c9dd19656823cb8250b0724ee9c60a82f3cdf68a080979d13092a3b0fef", size = 1885580, upload-time = "2025-04-23T18:31:57.393Z" },
-    { url = "https://files.pythonhosted.org/packages/3b/2a/953581f343c7d11a304581156618c3f592435523dd9d79865903272c256a/pydantic_core-2.33.2-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:2b0a451c263b01acebe51895bfb0e1cc842a5c666efe06cdf13846c7418caa9a", size = 1973859, upload-time = "2025-04-23T18:31:59.065Z" },
-    { url = "https://files.pythonhosted.org/packages/e6/55/f1a813904771c03a3f97f676c62cca0c0a4138654107c1b61f19c644868b/pydantic_core-2.33.2-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ea40a64d23faa25e62a70ad163571c0b342b8bf66d5fa612ac0dec4f069d916", size = 2120810, upload-time = "2025-04-23T18:32:00.78Z" },
-    { url = "https://files.pythonhosted.org/packages/aa/c3/053389835a996e18853ba107a63caae0b9deb4a276c6b472931ea9ae6e48/pydantic_core-2.33.2-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:0fb2d542b4d66f9470e8065c5469ec676978d625a8b7a363f07d9a501a9cb36a", size = 2676498, upload-time = "2025-04-23T18:32:02.418Z" },
-    { url = "https://files.pythonhosted.org/packages/eb/3c/f4abd740877a35abade05e437245b192f9d0ffb48bbbbd708df33d3cda37/pydantic_core-2.33.2-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9fdac5d6ffa1b5a83bca06ffe7583f5576555e6c8b3a91fbd25ea7780f825f7d", size = 2000611, upload-time = "2025-04-23T18:32:04.152Z" },
-    { url = "https://files.pythonhosted.org/packages/59/a7/63ef2fed1837d1121a894d0ce88439fe3e3b3e48c7543b2a4479eb99c2bd/pydantic_core-2.33.2-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:04a1a413977ab517154eebb2d326da71638271477d6ad87a769102f7c2488c56", size = 2107924, upload-time = "2025-04-23T18:32:06.129Z" },
-    { url = "https://files.pythonhosted.org/packages/04/8f/2551964ef045669801675f1cfc3b0d74147f4901c3ffa42be2ddb1f0efc4/pydantic_core-2.33.2-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:c8e7af2f4e0194c22b5b37205bfb293d166a7344a5b0d0eaccebc376546d77d5", size = 2063196, upload-time = "2025-04-23T18:32:08.178Z" },
-    { url = "https://files.pythonhosted.org/packages/26/bd/d9602777e77fc6dbb0c7db9ad356e9a985825547dce5ad1d30ee04903918/pydantic_core-2.33.2-cp313-cp313-musllinux_1_1_armv7l.whl", hash = "sha256:5c92edd15cd58b3c2d34873597a1e20f13094f59cf88068adb18947df5455b4e", size = 2236389, upload-time = "2025-04-23T18:32:10.242Z" },
-    { url = "https://files.pythonhosted.org/packages/42/db/0e950daa7e2230423ab342ae918a794964b053bec24ba8af013fc7c94846/pydantic_core-2.33.2-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:65132b7b4a1c0beded5e057324b7e16e10910c106d43675d9bd87d4f38dde162", size = 2239223, upload-time = "2025-04-23T18:32:12.382Z" },
-    { url = "https://files.pythonhosted.org/packages/58/4d/4f937099c545a8a17eb52cb67fe0447fd9a373b348ccfa9a87f141eeb00f/pydantic_core-2.33.2-cp313-cp313-win32.whl", hash = "sha256:52fb90784e0a242bb96ec53f42196a17278855b0f31ac7c3cc6f5c1ec4811849", size = 1900473, upload-time = "2025-04-23T18:32:14.034Z" },
-    { url = "https://files.pythonhosted.org/packages/a0/75/4a0a9bac998d78d889def5e4ef2b065acba8cae8c93696906c3a91f310ca/pydantic_core-2.33.2-cp313-cp313-win_amd64.whl", hash = "sha256:c083a3bdd5a93dfe480f1125926afcdbf2917ae714bdb80b36d34318b2bec5d9", size = 1955269, upload-time = "2025-04-23T18:32:15.783Z" },
-    { url = "https://files.pythonhosted.org/packages/f9/86/1beda0576969592f1497b4ce8e7bc8cbdf614c352426271b1b10d5f0aa64/pydantic_core-2.33.2-cp313-cp313-win_arm64.whl", hash = "sha256:e80b087132752f6b3d714f041ccf74403799d3b23a72722ea2e6ba2e892555b9", size = 1893921, upload-time = "2025-04-23T18:32:18.473Z" },
-    { url = "https://files.pythonhosted.org/packages/a4/7d/e09391c2eebeab681df2b74bfe6c43422fffede8dc74187b2b0bf6fd7571/pydantic_core-2.33.2-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:61c18fba8e5e9db3ab908620af374db0ac1baa69f0f32df4f61ae23f15e586ac", size = 1806162, upload-time = "2025-04-23T18:32:20.188Z" },
-    { url = "https://files.pythonhosted.org/packages/f1/3d/847b6b1fed9f8ed3bb95a9ad04fbd0b212e832d4f0f50ff4d9ee5a9f15cf/pydantic_core-2.33.2-cp313-cp313t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:95237e53bb015f67b63c91af7518a62a8660376a6a0db19b89acc77a4d6199f5", size = 1981560, upload-time = "2025-04-23T18:32:22.354Z" },
-    { url = "https://files.pythonhosted.org/packages/6f/9a/e73262f6c6656262b5fdd723ad90f518f579b7bc8622e43a942eec53c938/pydantic_core-2.33.2-cp313-cp313t-win_amd64.whl", hash = "sha256:c2fc0a768ef76c15ab9238afa6da7f69895bb5d1ee83aeea2e3509af4472d0b9", size = 1935777, upload-time = "2025-04-23T18:32:25.088Z" },
-    { url = "https://files.pythonhosted.org/packages/30/68/373d55e58b7e83ce371691f6eaa7175e3a24b956c44628eb25d7da007917/pydantic_core-2.33.2-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:5c4aa4e82353f65e548c476b37e64189783aa5384903bfea4f41580f255fddfa", size = 2023982, upload-time = "2025-04-23T18:32:53.14Z" },
-    { url = "https://files.pythonhosted.org/packages/a4/16/145f54ac08c96a63d8ed6442f9dec17b2773d19920b627b18d4f10a061ea/pydantic_core-2.33.2-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:d946c8bf0d5c24bf4fe333af284c59a19358aa3ec18cb3dc4370080da1e8ad29", size = 1858412, upload-time = "2025-04-23T18:32:55.52Z" },
-    { url = "https://files.pythonhosted.org/packages/41/b1/c6dc6c3e2de4516c0bb2c46f6a373b91b5660312342a0cf5826e38ad82fa/pydantic_core-2.33.2-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:87b31b6846e361ef83fedb187bb5b4372d0da3f7e28d85415efa92d6125d6e6d", size = 1892749, upload-time = "2025-04-23T18:32:57.546Z" },
-    { url = "https://files.pythonhosted.org/packages/12/73/8cd57e20afba760b21b742106f9dbdfa6697f1570b189c7457a1af4cd8a0/pydantic_core-2.33.2-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:aa9d91b338f2df0508606f7009fde642391425189bba6d8c653afd80fd6bb64e", size = 2067527, upload-time = "2025-04-23T18:32:59.771Z" },
-    { url = "https://files.pythonhosted.org/packages/e3/d5/0bb5d988cc019b3cba4a78f2d4b3854427fc47ee8ec8e9eaabf787da239c/pydantic_core-2.33.2-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:2058a32994f1fde4ca0480ab9d1e75a0e8c87c22b53a3ae66554f9af78f2fe8c", size = 2108225, upload-time = "2025-04-23T18:33:04.51Z" },
-    { url = "https://files.pythonhosted.org/packages/f1/c5/00c02d1571913d496aabf146106ad8239dc132485ee22efe08085084ff7c/pydantic_core-2.33.2-pp310-pypy310_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:0e03262ab796d986f978f79c943fc5f620381be7287148b8010b4097f79a39ec", size = 2069490, upload-time = "2025-04-23T18:33:06.391Z" },
-    { url = "https://files.pythonhosted.org/packages/22/a8/dccc38768274d3ed3a59b5d06f59ccb845778687652daa71df0cab4040d7/pydantic_core-2.33.2-pp310-pypy310_pp73-musllinux_1_1_armv7l.whl", hash = "sha256:1a8695a8d00c73e50bff9dfda4d540b7dee29ff9b8053e38380426a85ef10052", size = 2237525, upload-time = "2025-04-23T18:33:08.44Z" },
-    { url = "https://files.pythonhosted.org/packages/d4/e7/4f98c0b125dda7cf7ccd14ba936218397b44f50a56dd8c16a3091df116c3/pydantic_core-2.33.2-pp310-pypy310_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:fa754d1850735a0b0e03bcffd9d4b4343eb417e47196e4485d9cca326073a42c", size = 2238446, upload-time = "2025-04-23T18:33:10.313Z" },
-    { url = "https://files.pythonhosted.org/packages/ce/91/2ec36480fdb0b783cd9ef6795753c1dea13882f2e68e73bce76ae8c21e6a/pydantic_core-2.33.2-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:a11c8d26a50bfab49002947d3d237abe4d9e4b5bdc8846a63537b6488e197808", size = 2066678, upload-time = "2025-04-23T18:33:12.224Z" },
-    { url = "https://files.pythonhosted.org/packages/7b/27/d4ae6487d73948d6f20dddcd94be4ea43e74349b56eba82e9bdee2d7494c/pydantic_core-2.33.2-pp311-pypy311_pp73-macosx_10_12_x86_64.whl", hash = "sha256:dd14041875d09cc0f9308e37a6f8b65f5585cf2598a53aa0123df8b129d481f8", size = 2025200, upload-time = "2025-04-23T18:33:14.199Z" },
-    { url = "https://files.pythonhosted.org/packages/f1/b8/b3cb95375f05d33801024079b9392a5ab45267a63400bf1866e7ce0f0de4/pydantic_core-2.33.2-pp311-pypy311_pp73-macosx_11_0_arm64.whl", hash = "sha256:d87c561733f66531dced0da6e864f44ebf89a8fba55f31407b00c2f7f9449593", size = 1859123, upload-time = "2025-04-23T18:33:16.555Z" },
-    { url = "https://files.pythonhosted.org/packages/05/bc/0d0b5adeda59a261cd30a1235a445bf55c7e46ae44aea28f7bd6ed46e091/pydantic_core-2.33.2-pp311-pypy311_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2f82865531efd18d6e07a04a17331af02cb7a651583c418df8266f17a63c6612", size = 1892852, upload-time = "2025-04-23T18:33:18.513Z" },
-    { url = "https://files.pythonhosted.org/packages/3e/11/d37bdebbda2e449cb3f519f6ce950927b56d62f0b84fd9cb9e372a26a3d5/pydantic_core-2.33.2-pp311-pypy311_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2bfb5112df54209d820d7bf9317c7a6c9025ea52e49f46b6a2060104bba37de7", size = 2067484, upload-time = "2025-04-23T18:33:20.475Z" },
-    { url = "https://files.pythonhosted.org/packages/8c/55/1f95f0a05ce72ecb02a8a8a1c3be0579bbc29b1d5ab68f1378b7bebc5057/pydantic_core-2.33.2-pp311-pypy311_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:64632ff9d614e5eecfb495796ad51b0ed98c453e447a76bcbeeb69615079fc7e", size = 2108896, upload-time = "2025-04-23T18:33:22.501Z" },
-    { url = "https://files.pythonhosted.org/packages/53/89/2b2de6c81fa131f423246a9109d7b2a375e83968ad0800d6e57d0574629b/pydantic_core-2.33.2-pp311-pypy311_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:f889f7a40498cc077332c7ab6b4608d296d852182211787d4f3ee377aaae66e8", size = 2069475, upload-time = "2025-04-23T18:33:24.528Z" },
-    { url = "https://files.pythonhosted.org/packages/b8/e9/1f7efbe20d0b2b10f6718944b5d8ece9152390904f29a78e68d4e7961159/pydantic_core-2.33.2-pp311-pypy311_pp73-musllinux_1_1_armv7l.whl", hash = "sha256:de4b83bb311557e439b9e186f733f6c645b9417c84e2eb8203f3f820a4b988bf", size = 2239013, upload-time = "2025-04-23T18:33:26.621Z" },
-    { url = "https://files.pythonhosted.org/packages/3c/b2/5309c905a93811524a49b4e031e9851a6b00ff0fb668794472ea7746b448/pydantic_core-2.33.2-pp311-pypy311_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:82f68293f055f51b51ea42fafc74b6aad03e70e191799430b90c13d643059ebb", size = 2238715, upload-time = "2025-04-23T18:33:28.656Z" },
-    { url = "https://files.pythonhosted.org/packages/32/56/8a7ca5d2cd2cda1d245d34b1c9a942920a718082ae8e54e5f3e5a58b7add/pydantic_core-2.33.2-pp311-pypy311_pp73-win_amd64.whl", hash = "sha256:329467cecfb529c925cf2bbd4d60d2c509bc2fb52a20c1045bf09bb70971a9c1", size = 2066757, upload-time = "2025-04-23T18:33:30.645Z" },
-]
-
-[[package]]
-name = "pydantic-settings"
-version = "2.9.1"
-source = { registry = "https://pypi.org/simple" }
-dependencies = [
-    { name = "pydantic" },
-    { name = "python-dotenv" },
-    { name = "typing-inspection" },
-]
-sdist = { url = "https://files.pythonhosted.org/packages/67/1d/42628a2c33e93f8e9acbde0d5d735fa0850f3e6a2f8cb1eb6c40b9a732ac/pydantic_settings-2.9.1.tar.gz", hash = "sha256:c509bf79d27563add44e8446233359004ed85066cd096d8b510f715e6ef5d268", size = 163234, upload-time = "2025-04-18T16:44:48.265Z" }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/b6/5f/d6d641b490fd3ec2c4c13b4244d68deea3a1b970a97be64f34fb5504ff72/pydantic_settings-2.9.1-py3-none-any.whl", hash = "sha256:59b4f431b1defb26fe620c71a7d3968a710d719f5f4cdbbdb7926edeb770f6ef", size = 44356, upload-time = "2025-04-18T16:44:46.617Z" },
-]
-
 [[package]]
 name = "pygments"
 version = "2.19.1"
@@ -280,7 +155,7 @@ wheels = [
 
 [[package]]
 name = "typer"
-version = "0.15.4"
+version = "0.16.0"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "click" },
@@ -288,9 +163,9 @@ dependencies = [
     { name = "shellingham" },
     { name = "typing-extensions" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/6c/89/c527e6c848739be8ceb5c44eb8208c52ea3515c6cf6406aa61932887bf58/typer-0.15.4.tar.gz", hash = "sha256:89507b104f9b6a0730354f27c39fae5b63ccd0c95b1ce1f1a6ba0cfd329997c3", size = 101559, upload-time = "2025-05-14T16:34:57.704Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/c5/8c/7d682431efca5fd290017663ea4588bf6f2c6aad085c7f108c5dbc316e70/typer-0.16.0.tar.gz", hash = "sha256:af377ffaee1dbe37ae9440cb4e8f11686ea5ce4e9bae01b84ae7c63b87f1dd3b", size = 102625, upload-time = "2025-05-26T14:30:31.824Z" }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/c9/62/d4ba7afe2096d5659ec3db8b15d8665bdcb92a3c6ff0b95e99895b335a9c/typer-0.15.4-py3-none-any.whl", hash = "sha256:eb0651654dcdea706780c466cf06d8f174405a659ffff8f163cfbfee98c0e173", size = 45258, upload-time = "2025-05-14T16:34:55.583Z" },
+    { url = "https://files.pythonhosted.org/packages/76/42/3efaf858001d2c2913de7f354563e3a3a2f0decae3efe98427125a8f441e/typer-0.16.0-py3-none-any.whl", hash = "sha256:1f79bed11d4d02d4310e3c1b7ba594183bcedb0ac73b27a9e5f28f6fb5b98855", size = 46317, upload-time = "2025-05-26T14:30:30.523Z" },
 ]
 
 [[package]]
@@ -302,18 +177,6 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/8b/54/b1ae86c0973cc6f0210b53d508ca3641fb6d0c56823f288d108bc7ab3cc8/typing_extensions-4.13.2-py3-none-any.whl", hash = "sha256:a439e7c04b49fec3e5d3e2beaa21755cadbbdc391694e28ccdd36ca4a1408f8c", size = 45806, upload-time = "2025-04-10T14:19:03.967Z" },
 ]
 
-[[package]]
-name = "typing-inspection"
-version = "0.4.1"
-source = { registry = "https://pypi.org/simple" }
-dependencies = [
-    { name = "typing-extensions" },
-]
-sdist = { url = "https://files.pythonhosted.org/packages/f8/b1/0c11f5058406b3af7609f121aaa6b609744687f1d158b3c3a5bf4cc94238/typing_inspection-0.4.1.tar.gz", hash = "sha256:6ae134cc0203c33377d43188d4064e9b357dba58cff3185f22924610e70a9d28", size = 75726, upload-time = "2025-05-21T18:55:23.885Z" }
-wheels = [
-    { url = "https://files.pythonhosted.org/packages/17/69/cd203477f944c353c31bade965f880aa1061fd6bf05ded0726ca845b6ff7/typing_inspection-0.4.1-py3-none-any.whl", hash = "sha256:389055682238f53b04f7badcb49b989835495a96700ced5dab2d8feae4b26f51", size = 14552, upload-time = "2025-05-21T18:55:22.152Z" },
-]
-
 [[package]]
 name = "websocket-client"
 version = "1.8.0"