upd publish action

add link to style section in ToC.

add imgs.

.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@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        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@v4
+      - uses: astral-sh/ruff-action@v3
+        with:
+          args: 'format --check --diff'

CHANGELOG.md

@@ -5,6 +5,28 @@ 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.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

README.md

@@ -14,6 +14,7 @@ For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
 
 - [Installation](#installation)
 - [Configuration](#configuration)
+- [Style](#style)
 - [Commands](#root-typer)
 - [License](#license)
 
@@ -68,6 +69,37 @@ OBS_PASSWORD=<websocket password>
 
 Flags can be used to override environment variables.
 
+## Style
+
+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 --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
+OBS_STYLE=cyan
+OBS_STYLE_NO_BORDER=true
+```
+
 ## Root Typer
 
 -   obs-version: Get the OBS Client and WebSocket versions.
@@ -303,6 +335,22 @@ obsws-cli input unmute "Mic/Aux"
 obsws-cli input toggle "Mic/Aux"
 ```
 
+#### 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.
@@ -354,6 +402,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.
@@ -613,14 +676,6 @@ obsws-cli projector open --monitor-index=1 "test_group"
 obsws-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\screenshot.png"
 ```
 
-## Disable Colouring
-
-If you prefer colourless output you can set the environment variable `NO_COLOR`, see [NO_COLOR][no-colour].
-
-```console
-NO_COLOR="1" obsws-cli scene list
-```
-
 ## License
 
 `obsws-cli` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

obsws_cli/__about__.py

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

obsws_cli/__init__.py

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

obsws_cli/alias.py

@@ -44,6 +44,8 @@ class RootTyperAliasGroup(typer.core.TyperGroup):
                 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)

obsws_cli/app.py

@@ -7,9 +7,9 @@ from typing import Annotated
 import obsws_python as obsws
 import typer
 
-from obsws_cli.__about__ import __version__ as obsws_cli_version
+from obsws_cli.__about__ import __version__ as version
 
-from . import console, settings
+from . import console, settings, styles
 from .alias import RootTyperAliasGroup
 
 app = typer.Typer(cls=RootTyperAliasGroup)
@@ -28,6 +28,7 @@ for sub_typer in (
     'screenshot',
     'stream',
     'studiomode',
+    'text',
     'virtualcam',
 ):
     module = importlib.import_module(f'.{sub_typer}', package=__package__)
@@ -37,7 +38,7 @@ for sub_typer in (
 def version_callback(value: bool):
     """Show the version of the CLI."""
     if value:
-        console.out.print(f'obsws-cli version: {obsws_cli_version}')
+        console.out.print(f'obsws-cli version: {version}')
         raise typer.Exit()
 
 
@@ -50,6 +51,15 @@ def setup_logging(debug: bool):
     )
 
 
+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,
@@ -104,6 +114,27 @@ def main(
             callback=version_callback,
         ),
     ] = False,
+    style: Annotated[
+        str,
+        typer.Option(
+            '--style',
+            '-s',
+            envvar='OBS_STYLE',
+            help='Set the style for the CLI output',
+            show_default='disabled',
+            callback=validate_style,
+        ),
+    ] = settings.get('style'),
+    no_border: Annotated[
+        bool,
+        typer.Option(
+            '--no-border',
+            '-b',
+            envvar='OBS_STYLE_NO_BORDER',
+            help='Disable table border styling in the CLI output',
+            show_default=False,
+        ),
+    ] = settings.get('style_no_border'),
     debug: Annotated[
         bool,
         typer.Option(
@@ -119,13 +150,16 @@ def main(
     ] = settings.get('debug'),
 ):
     """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(**ctx.params))
+    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()
+    resp = ctx.obj['obsws'].get_version()
     console.out.print(
-        f'OBS Client version: {resp.obs_version} with WebSocket version: {resp.obs_web_socket_version}'
+        f'OBS Client version: {console.highlight(ctx, resp.obs_version)}'
+        f' with WebSocket version: {console.highlight(ctx, resp.obs_web_socket_version)}'
     )

obsws_cli/console.py

@@ -1,6 +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/filter.py

@@ -5,6 +5,7 @@ from typing import Annotated, Optional
 import obsws_python as obsws
 import typer
 from rich.table import Table
+from rich.text import Text
 
 from . import console, util
 from .alias import SubTyperAliasGroup
@@ -30,10 +31,10 @@ def list_(
 ):
     """List filters for a source."""
     if not source_name:
-        source_name = ctx.obj.get_current_program_scene().scene_name
+        source_name = ctx.obj['obsws'].get_current_program_scene().scene_name
 
     try:
-        resp = ctx.obj.get_source_filter_list(source_name)
+        resp = ctx.obj['obsws'].get_source_filter_list(source_name)
     except obsws.error.OBSSDKRequestError as e:
         if e.code == 600:
             console.err.print(
@@ -44,22 +45,28 @@ def list_(
             raise
 
     if not resp.filters:
-        console.out.print(f'No filters found for source [yellow]{source_name}[/yellow]')
+        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))
+    table = Table(
+        title=f'Filters for Source: {source_name}',
+        padding=(0, 2),
+        border_style=ctx.obj['style'].border,
+    )
 
     columns = [
-        ('Filter Name', 'left', 'cyan'),
-        ('Kind', 'left', 'cyan'),
-        ('Enabled', 'center', None),
-        ('Settings', 'center', 'cyan'),
+        (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 name, justify, style in columns:
-        table.add_column(name, justify=justify, style=style)
+    for heading, justify, style in columns:
+        table.add_column(heading, justify=justify, style=style)
 
     for filter in resp.filters:
-        resp = ctx.obj.get_source_filter_default_settings(filter['filterKind'])
+        resp = ctx.obj['obsws'].get_source_filter_default_settings(filter['filterKind'])
         settings = resp.default_filter_settings | filter['filterSettings']
 
         table.add_row(
@@ -79,7 +86,7 @@ def list_(
 
 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)
+    resp = ctx.obj['obsws'].get_source_filter(source_name, filter_name)
     return resp.filter_enabled
 
 
@@ -106,9 +113,9 @@ def enable(
         )
         raise typer.Exit(1)
 
-    ctx.obj.set_source_filter_enabled(source_name, filter_name, enabled=True)
+    ctx.obj['obsws'].set_source_filter_enabled(source_name, filter_name, enabled=True)
     console.out.print(
-        f'Enabled filter [green]{filter_name}[/green] for source [green]{source_name}[/green]'
+        f'Enabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
     )
 
 
@@ -135,9 +142,9 @@ def disable(
         )
         raise typer.Exit(1)
 
-    ctx.obj.set_source_filter_enabled(source_name, filter_name, enabled=False)
+    ctx.obj['obsws'].set_source_filter_enabled(source_name, filter_name, enabled=False)
     console.out.print(
-        f'Disabled filter [green]{filter_name}[/green] for source [green]{source_name}[/green]'
+        f'Disabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
     )
 
 
@@ -161,14 +168,16 @@ def toggle(
     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)
+    ctx.obj['obsws'].set_source_filter_enabled(
+        source_name, filter_name, enabled=new_state
+    )
     if new_state:
         console.out.print(
-            f'Enabled filter [green]{filter_name}[/green] for source [green]{source_name}[/green]'
+            f'Enabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
         )
     else:
         console.out.print(
-            f'Disabled filter [green]{filter_name}[/green] for source [green]{source_name}[/green]'
+            f'Disabled filter {console.highlight(ctx, filter_name)} for source {console.highlight(ctx, source_name)}'
         )
 
 
@@ -192,9 +201,9 @@ def status(
     is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
     if is_enabled:
         console.out.print(
-            f'Filter [green]{filter_name}[/green] is enabled for source [green]{source_name}[/green]'
+            f'Filter {console.highlight(ctx, filter_name)} is enabled for source {console.highlight(ctx, source_name)}'
         )
     else:
         console.out.print(
-            f'Filter [green]{filter_name}[/green] is disabled for source [green]{source_name}[/green]'
+            f'Filter {console.highlight(ctx, filter_name)} is disabled for source {console.highlight(ctx, source_name)}'
         )

obsws_cli/group.py

@@ -4,6 +4,7 @@ from typing import Annotated, Optional
 
 import typer
 from rich.table import Table
+from rich.text import Text
 
 from . import console, util, validate
 from .alias import SubTyperAliasGroup
@@ -30,13 +31,13 @@ def list_(
 ):
     """List groups in a scene."""
     if not scene_name:
-        scene_name = ctx.obj.get_current_program_scene().scene_name
+        scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
 
     if not validate.scene_in_scenes(ctx, scene_name):
         console.err.print(f"Scene '{scene_name}' not found.")
         raise typer.Exit(1)
 
-    resp = ctx.obj.get_scene_item_list(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
@@ -44,18 +45,24 @@ def list_(
     ]
 
     if not groups:
-        console.out.print(f"No groups found in scene '{scene_name}'.")
+        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))
+    table = Table(
+        title=f'Groups in Scene: {scene_name}',
+        padding=(0, 2),
+        border_style=ctx.obj['style'].border,
+    )
 
     columns = [
-        ('ID', 'center', 'cyan'),
-        ('Group Name', 'left', 'cyan'),
-        ('Enabled', 'center', None),
+        (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 column, justify, style in columns:
-        table.add_column(column, justify=justify, style=style)
+    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(
@@ -96,20 +103,20 @@ def show(
         console.err.print(f"Scene '{scene_name}' not found.")
         raise typer.Exit(1)
 
-    resp = ctx.obj.get_scene_item_list(scene_name)
+    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.set_scene_item_enabled(
+    ctx.obj['obsws'].set_scene_item_enabled(
         scene_name=scene_name,
         item_id=int(group.get('sceneItemId')),
         enabled=True,
     )
 
-    console.out.print(f'Group [green]{group_name}[/green] is now visible.')
+    console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
 
 
 @app.command('hide | h')
@@ -127,20 +134,20 @@ def hide(
         console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
         raise typer.Exit(1)
 
-    resp = ctx.obj.get_scene_item_list(scene_name)
+    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.set_scene_item_enabled(
+    ctx.obj['obsws'].set_scene_item_enabled(
         scene_name=scene_name,
         item_id=int(group.get('sceneItemId')),
         enabled=False,
     )
 
-    console.out.print(f'Group [green]{group_name}[/green] is now hidden.')
+    console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
 
 
 @app.command('toggle | tg')
@@ -158,7 +165,7 @@ def toggle(
         console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
         raise typer.Exit(1)
 
-    resp = ctx.obj.get_scene_item_list(scene_name)
+    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].'
@@ -166,16 +173,16 @@ def toggle(
         raise typer.Exit(1)
 
     new_state = not group.get('sceneItemEnabled')
-    ctx.obj.set_scene_item_enabled(
+    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 [green]{group_name}[/green] is now visible.')
+        console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
     else:
-        console.out.print(f'Group [green]{group_name}[/green] is now hidden.')
+        console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
 
 
 @app.command('status | ss')
@@ -193,19 +200,19 @@ def status(
         console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
         raise typer.Exit(1)
 
-    resp = ctx.obj.get_scene_item_list(scene_name)
+    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.get_scene_item_enabled(
+    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 [green]{group_name}[/green] is now visible.')
+        console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
     else:
-        console.out.print(f'Group [green]{group_name}[/green] is now hidden.')
+        console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')

obsws_cli/hotkey.py

@@ -4,6 +4,7 @@ from typing import Annotated
 
 import typer
 from rich.table import Table
+from rich.text import Text
 
 from . import console
 from .alias import SubTyperAliasGroup
@@ -21,13 +22,21 @@ def list_(
     ctx: typer.Context,
 ):
     """List all hotkeys."""
-    resp = ctx.obj.get_hotkey_list()
+    resp = ctx.obj['obsws'].get_hotkey_list()
 
-    table = Table(title='Hotkeys', padding=(0, 2))
-    table.add_column('Hotkey Name', justify='left', style='cyan')
+    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 hotkey in resp.hotkeys:
-        table.add_row(hotkey)
+    for i, hotkey in enumerate(resp.hotkeys):
+        table.add_row(hotkey, style='' if i % 2 == 0 else 'dim')
 
     console.out.print(table)
 
@@ -40,7 +49,7 @@ def trigger(
     ],
 ):
     """Trigger a hotkey by name."""
-    ctx.obj.trigger_hotkey_by_name(hotkey)
+    ctx.obj['obsws'].trigger_hotkey_by_name(hotkey)
 
 
 @app.command('trigger-sequence | trs')
@@ -68,4 +77,4 @@ def trigger_sequence(
     ] = False,
 ):
     """Trigger a hotkey by sequence."""
-    ctx.obj.trigger_hotkey_by_key_sequence(key_id, shift, ctrl, alt, cmd)
+    ctx.obj['obsws'].trigger_hotkey_by_key_sequence(key_id, shift, ctrl, alt, cmd)

obsws_cli/input.py

@@ -5,6 +5,7 @@ from typing import Annotated
 import obsws_python as obsws
 import typer
 from rich.table import Table
+from rich.text import Text
 
 from . import console, util, validate
 from .alias import SubTyperAliasGroup
@@ -28,7 +29,7 @@ def list_(
     uuid: Annotated[bool, typer.Option(help='Show UUIDs of inputs.')] = False,
 ):
     """List all inputs."""
-    resp = ctx.obj.get_input_list()
+    resp = ctx.obj['obsws'].get_input_list()
 
     kinds = []
     if input:
@@ -42,7 +43,7 @@ def list_(
     if vlc:
         kinds.append('vlc')
     if not any([input, output, colour, ffmpeg, vlc]):
-        kinds = ctx.obj.get_input_kind_list(False).input_kinds
+        kinds = ctx.obj['obsws'].get_input_kind_list(False).input_kinds
 
     inputs = sorted(
         (
@@ -59,28 +60,27 @@ def list_(
         console.out.print('No inputs found.')
         raise typer.Exit()
 
-    table = Table(title='Inputs', padding=(0, 2))
+    table = Table(title='Inputs', padding=(0, 2), border_style=ctx.obj['style'].border)
     if uuid:
         columns = [
-            ('Input Name', 'left', 'cyan'),
-            ('Kind', 'center', 'cyan'),
-            ('Muted', 'center', None),
-            ('UUID', 'left', 'cyan'),
+            (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:
-        table.title += ' (UUIDs hidden)'
         columns = [
-            ('Input Name', 'left', 'cyan'),
-            ('Kind', 'center', 'cyan'),
-            ('Muted', 'center', None),
+            (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 column, justify, style in columns:
-        table.add_column(column, justify=justify, style=style)
+    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.get_input_mute(name=input_name).input_muted
+            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
@@ -117,12 +117,12 @@ def mute(
         console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
         raise typer.Exit(1)
 
-    ctx.obj.set_input_mute(
+    ctx.obj['obsws'].set_input_mute(
         name=input_name,
         muted=True,
     )
 
-    console.out.print(f'Input [green]{input_name}[/green] muted.')
+    console.out.print(f'Input {console.highlight(ctx, input_name)} muted.')
 
 
 @app.command('unmute | um')
@@ -138,12 +138,12 @@ def unmute(
         console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
         raise typer.Exit(1)
 
-    ctx.obj.set_input_mute(
+    ctx.obj['obsws'].set_input_mute(
         name=input_name,
         muted=False,
     )
 
-    console.out.print(f'Input [green]{input_name}[/green] unmuted.')
+    console.out.print(f'Input {console.highlight(ctx, input_name)} unmuted.')
 
 
 @app.command('toggle | tg')
@@ -159,19 +159,19 @@ def toggle(
         console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
         raise typer.Exit(1)
 
-    resp = ctx.obj.get_input_mute(name=input_name)
+    resp = ctx.obj['obsws'].get_input_mute(name=input_name)
     new_state = not resp.input_muted
 
-    ctx.obj.set_input_mute(
+    ctx.obj['obsws'].set_input_mute(
         name=input_name,
         muted=new_state,
     )
 
     if new_state:
         console.out.print(
-            f'Input [green]{input_name}[/green] muted.',
+            f'Input {console.highlight(ctx, input_name)} muted.',
         )
     else:
         console.out.print(
-            f'Input [green]{input_name}[/green] unmuted.',
+            f'Input {console.highlight(ctx, input_name)} unmuted.',
         )

obsws_cli/profile.py

@@ -4,6 +4,7 @@ from typing import Annotated
 
 import typer
 from rich.table import Table
+from rich.text import Text
 
 from . import console, util, validate
 from .alias import SubTyperAliasGroup
@@ -19,20 +20,24 @@ def main():
 @app.command('list | ls')
 def list_(ctx: typer.Context):
     """List profiles."""
-    resp = ctx.obj.get_profile_list()
+    resp = ctx.obj['obsws'].get_profile_list()
 
-    table = Table(title='Profiles', padding=(0, 2))
+    table = Table(
+        title='Profiles', padding=(0, 2), border_style=ctx.obj['style'].border
+    )
     columns = [
-        ('Profile Name', 'left', 'cyan'),
-        ('Current', 'center', None),
+        (Text('Profile Name', justify='center'), 'left', ctx.obj['style'].column),
+        (Text('Current', justify='center'), 'center', None),
     ]
-    for column, justify, style in columns:
-        table.add_column(column, justify=justify, style=style)
+    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(profile == resp.current_profile_name, empty_if_false=True),
+            util.check_mark(
+                ctx, profile == resp.current_profile_name, empty_if_false=True
+            ),
         )
 
     console.out.print(table)
@@ -41,8 +46,10 @@ def list_(ctx: typer.Context):
 @app.command('current | get')
 def current(ctx: typer.Context):
     """Get the current profile."""
-    resp = ctx.obj.get_profile_list()
-    console.out.print(resp.current_profile_name)
+    resp = ctx.obj['obsws'].get_profile_list()
+    console.out.print(
+        f'Current profile: {console.highlight(ctx, resp.current_profile_name)}'
+    )
 
 
 @app.command('switch | set')
@@ -60,15 +67,15 @@ def switch(
         console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
         raise typer.Exit(1)
 
-    resp = ctx.obj.get_profile_list()
+    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.set_current_profile(profile_name)
-    console.out.print(f'Switched to profile [green]{profile_name}[/green].')
+    ctx.obj['obsws'].set_current_profile(profile_name)
+    console.out.print(f'Switched to profile {console.highlight(ctx, profile_name)}.')
 
 
 @app.command('create | new')
@@ -84,8 +91,8 @@ def create(
         console.err.print(f'Profile [yellow]{profile_name}[/yellow] already exists.')
         raise typer.Exit(1)
 
-    ctx.obj.create_profile(profile_name)
-    console.out.print(f'Created profile [green]{profile_name}[/green].')
+    ctx.obj['obsws'].create_profile(profile_name)
+    console.out.print(f'Created profile {console.highlight(ctx, profile_name)}.')
 
 
 @app.command('remove | rm')
@@ -101,5 +108,5 @@ def remove(
         console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
         raise typer.Exit(1)
 
-    ctx.obj.remove_profile(profile_name)
-    console.out.print(f'Removed profile [green]{profile_name}[/green].')
+    ctx.obj['obsws'].remove_profile(profile_name)
+    console.out.print(f'Removed profile {console.highlight(ctx, profile_name)}.')

obsws_cli/projector.py

@@ -4,6 +4,7 @@ from typing import Annotated
 
 import typer
 from rich.table import Table
+from rich.text import Text
 
 from . import console
 from .alias import SubTyperAliasGroup
@@ -19,7 +20,7 @@ def main():
 @app.command('list-monitors | ls-m')
 def list_monitors(ctx: typer.Context):
     """List available monitors."""
-    resp = ctx.obj.get_monitor_list()
+    resp = ctx.obj['obsws'].get_monitor_list()
 
     if not resp.monitors:
         console.out.print('No monitors found.')
@@ -30,9 +31,17 @@ def list_monitors(ctx: typer.Context):
         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')
+    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)
@@ -57,18 +66,18 @@ def open(
 ):
     """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
+        source_name = ctx.obj['obsws'].get_current_program_scene().scene_name
 
-    monitors = ctx.obj.get_monitor_list().monitors
+    monitors = ctx.obj['obsws'].get_monitor_list().monitors
     for monitor in monitors:
         if monitor['monitorIndex'] == monitor_index:
-            ctx.obj.open_source_projector(
+            ctx.obj['obsws'].open_source_projector(
                 source_name=source_name,
                 monitor_index=monitor_index,
             )
 
             console.out.print(
-                f'Opened projector for source [green]{source_name}[/] on monitor [green]{monitor["monitorName"]}[/].'
+                f'Opened projector for source {console.highlight(ctx, source_name)} on monitor {console.highlight(ctx, monitor["monitorName"])}.'
             )
 
             break

obsws_cli/record.py

@@ -18,7 +18,7 @@ def main():
 
 def _get_recording_status(ctx: typer.Context) -> tuple:
     """Get recording status."""
-    resp = ctx.obj.get_record_status()
+    resp = ctx.obj['obsws'].get_record_status()
     return resp.output_active, resp.output_paused
 
 
@@ -34,7 +34,7 @@ def start(ctx: typer.Context):
         console.err.print(err_msg)
         raise typer.Exit(1)
 
-    ctx.obj.start_record()
+    ctx.obj['obsws'].start_record()
     console.out.print('Recording started successfully.')
 
 
@@ -46,16 +46,16 @@ def stop(ctx: typer.Context):
         console.err.print('Recording is not in progress, cannot stop.')
         raise typer.Exit(1)
 
-    resp = ctx.obj.stop_record()
+    resp = ctx.obj['obsws'].stop_record()
     console.out.print(
-        f'Recording stopped successfully. Saved to: [green]{resp.output_path}[/green]'
+        f'Recording stopped successfully. Saved to: {console.highlight(ctx, resp.output_path)}'
     )
 
 
 @app.command('toggle | tg')
 def toggle(ctx: typer.Context):
     """Toggle recording."""
-    resp = ctx.obj.toggle_record()
+    resp = ctx.obj['obsws'].toggle_record()
     if resp.output_active:
         console.out.print('Recording started successfully.')
     else:
@@ -86,7 +86,7 @@ def resume(ctx: typer.Context):
         console.err.print('Recording is in progress but not paused, cannot resume.')
         raise typer.Exit(1)
 
-    ctx.obj.resume_record()
+    ctx.obj['obsws'].resume_record()
     console.out.print('Recording resumed successfully.')
 
 
@@ -101,7 +101,7 @@ def pause(ctx: typer.Context):
         console.err.print('Recording is in progress but already paused, cannot pause.')
         raise typer.Exit(1)
 
-    ctx.obj.pause_record()
+    ctx.obj['obsws'].pause_record()
     console.out.print('Recording paused successfully.')
 
 
@@ -121,9 +121,52 @@ def directory(
 ):
     """Get or set the recording directory."""
     if record_directory is not None:
-        ctx.obj.set_record_directory(str(record_directory))
-        console.out.print(f'Recording directory updated to: {record_directory}')
-    else:
+        ctx.obj['obsws'].set_record_directory(str(record_directory))
         console.out.print(
-            f'Recording directory: [green]{ctx.obj.get_record_directory().record_directory}[/green]'
+            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 | sp')
+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 | ch')
+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/replaybuffer.py

@@ -16,31 +16,31 @@ def main():
 @app.command('start | s')
 def start(ctx: typer.Context):
     """Start the replay buffer."""
-    resp = ctx.obj.get_replay_buffer_status()
+    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.start_replay_buffer()
+    ctx.obj['obsws'].start_replay_buffer()
     console.out.print('Replay buffer started.')
 
 
 @app.command('stop | st')
 def stop(ctx: typer.Context):
     """Stop the replay buffer."""
-    resp = ctx.obj.get_replay_buffer_status()
+    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.stop_replay_buffer()
+    ctx.obj['obsws'].stop_replay_buffer()
     console.out.print('Replay buffer stopped.')
 
 
 @app.command('toggle | tg')
 def toggle(ctx: typer.Context):
     """Toggle the replay buffer."""
-    resp = ctx.obj.toggle_replay_buffer()
+    resp = ctx.obj['obsws'].toggle_replay_buffer()
     if resp.output_active:
         console.out.print('Replay buffer is active.')
     else:
@@ -50,7 +50,7 @@ def toggle(ctx: typer.Context):
 @app.command('status | ss')
 def status(ctx: typer.Context):
     """Get the status of the replay buffer."""
-    resp = ctx.obj.get_replay_buffer_status()
+    resp = ctx.obj['obsws'].get_replay_buffer_status()
     if resp.output_active:
         console.out.print('Replay buffer is active.')
     else:
@@ -60,5 +60,5 @@ def status(ctx: typer.Context):
 @app.command('save | sv')
 def save(ctx: typer.Context):
     """Save the replay buffer."""
-    ctx.obj.save_replay_buffer()
+    ctx.obj['obsws'].save_replay_buffer()
     console.out.print('Replay buffer saved.')

obsws_cli/scene.py

@@ -4,6 +4,7 @@ from typing import Annotated
 
 import typer
 from rich.table import Table
+from rich.text import Text
 
 from . import console, util, validate
 from .alias import SubTyperAliasGroup
@@ -22,45 +23,39 @@ def list_(
     uuid: Annotated[bool, typer.Option(help='Show UUIDs of scenes')] = False,
 ):
     """List all scenes."""
-    resp = ctx.obj.get_scene_list()
+    resp = ctx.obj['obsws'].get_scene_list()
     scenes = (
         (scene.get('sceneName'), scene.get('sceneUuid'))
         for scene in reversed(resp.scenes)
     )
 
-    active_scene = ctx.obj.get_current_program_scene().scene_name
+    active_scene = ctx.obj['obsws'].get_current_program_scene().scene_name
 
-    table = Table(title='Scenes', padding=(0, 2))
+    table = Table(title='Scenes', padding=(0, 2), border_style=ctx.obj['style'].border)
     if uuid:
         columns = [
-            ('Scene Name', 'left', 'cyan'),
-            ('Active', 'center', None),
-            ('UUID', 'left', 'cyan'),
+            (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:
-        table.title += ' (UUIDs hidden)'
         columns = [
-            ('Scene Name', 'left', 'cyan'),
-            ('Active', 'center', None),
+            (Text('Scene Name', justify='center'), 'left', ctx.obj['style'].column),
+            (Text('Active', justify='center'), 'center', None),
         ]
-    for column, justify, style in columns:
-        table.add_column(column, justify=justify, style=style)
+    for heading, justify, style in columns:
+        table.add_column(heading, justify=justify, style=style)
 
     for scene_name, scene_uuid in scenes:
-        if scene_name == active_scene:
-            scene_output = f'[bold]{scene_name}[/bold]'
-        else:
-            scene_output = f'[dim]{scene_name}[/dim]'
-
         if uuid:
             table.add_row(
-                scene_output,
+                scene_name,
                 util.check_mark(scene_name == active_scene, empty_if_false=True),
                 scene_uuid,
             )
         else:
             table.add_row(
-                scene_output,
+                scene_name,
                 util.check_mark(scene_name == active_scene, empty_if_false=True),
             )
 
@@ -80,11 +75,15 @@ def current(
         raise typer.Exit(1)
 
     if preview:
-        resp = ctx.obj.get_current_preview_scene()
-        console.out.print(resp.current_preview_scene_name)
+        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.get_current_program_scene()
-        console.out.print(resp.current_program_scene_name)
+        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 | set')
@@ -108,8 +107,12 @@ def switch(
         raise typer.Exit(1)
 
     if preview:
-        ctx.obj.set_current_preview_scene(scene_name)
-        console.out.print(f'Switched to preview scene: [green]{scene_name}[/green]')
+        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.set_current_program_scene(scene_name)
-        console.out.print(f'Switched to program scene: [green]{scene_name}[/green]')
+        ctx.obj['obsws'].set_current_program_scene(scene_name)
+        console.out.print(
+            f'Switched to program scene: {console.highlight(ctx, scene_name)}'
+        )

obsws_cli/scenecollection.py

@@ -19,10 +19,16 @@ def main():
 @app.command('list | ls')
 def list_(ctx: typer.Context):
     """List all scene collections."""
-    resp = ctx.obj.get_scene_collection_list()
+    resp = ctx.obj['obsws'].get_scene_collection_list()
 
-    table = Table(title='Scene Collections', padding=(0, 2))
-    table.add_column('Scene Collection Name', justify='left', style='cyan')
+    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)
@@ -33,8 +39,10 @@ def list_(ctx: typer.Context):
 @app.command('current | get')
 def current(ctx: typer.Context):
     """Get the current scene collection."""
-    resp = ctx.obj.get_scene_collection_list()
-    console.out.print(resp.current_scene_collection_name)
+    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 | set')
@@ -52,7 +60,7 @@ def switch(
         raise typer.Exit(1)
 
     current_scene_collection = (
-        ctx.obj.get_scene_collection_list().current_scene_collection_name
+        ctx.obj['obsws'].get_scene_collection_list().current_scene_collection_name
     )
     if scene_collection_name == current_scene_collection:
         console.err.print(
@@ -60,9 +68,9 @@ def switch(
         )
         raise typer.Exit(1)
 
-    ctx.obj.set_current_scene_collection(scene_collection_name)
+    ctx.obj['obsws'].set_current_scene_collection(scene_collection_name)
     console.out.print(
-        f'Switched to scene collection [green]{scene_collection_name}[/green].'
+        f'Switched to scene collection {console.highlight(ctx, scene_collection_name)}.'
     )
 
 
@@ -80,7 +88,7 @@ def create(
         )
         raise typer.Exit(1)
 
-    ctx.obj.create_scene_collection(scene_collection_name)
+    ctx.obj['obsws'].create_scene_collection(scene_collection_name)
     console.out.print(
-        f'Created scene collection [green]{scene_collection_name}[/green].'
+        f'Created scene collection {console.highlight(ctx, scene_collection_name)}.'
     )

obsws_cli/sceneitem.py

@@ -30,13 +30,13 @@ def list_(
 ):
     """List all items in a scene."""
     if not scene_name:
-        scene_name = ctx.obj.get_current_program_scene().scene_name
+        scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
 
     if not validate.scene_in_scenes(ctx, scene_name):
         console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
         raise typer.Exit(1)
 
-    resp = ctx.obj.get_scene_item_list(scene_name)
+    resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
     items = sorted(
         (
             (
@@ -52,33 +52,38 @@ def list_(
     )
 
     if not items:
-        console.out.print(f'No items found in scene [green]{scene_name}[/green].')
+        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))
+    table = Table(
+        title=f'Items in Scene: {scene_name}',
+        padding=(0, 2),
+        border_style=ctx.obj['style'].border,
+    )
     if uuid:
         columns = [
-            ('Item ID', 'center', 'cyan'),
-            ('Item Name', 'left', 'cyan'),
-            ('In Group', 'left', 'cyan'),
+            ('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', 'cyan'),
+            ('UUID', 'left', ctx.obj['style'].column),
         ]
     else:
-        table.title += ' (UUIDs hidden)'
         columns = [
-            ('Item ID', 'center', 'cyan'),
-            ('Item Name', 'left', 'cyan'),
-            ('In Group', 'left', 'cyan'),
+            ('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 column, justify, style in columns:
-        table.add_column(column, justify=justify, style=style)
+    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.get_group_scene_item_list(item_name)
+            resp = ctx.obj['obsws'].get_group_scene_item_list(item_name)
             group_items = sorted(
                 (
                     (
@@ -166,7 +171,7 @@ def _get_scene_name_and_item_id(
 ):
     """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)
+        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
@@ -178,7 +183,7 @@ def _get_scene_name_and_item_id(
             )
             raise typer.Exit(1)
     else:
-        resp = ctx.obj.get_scene_item_id(scene_name, item_name)
+        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
@@ -205,7 +210,7 @@ def show(
         ctx, scene_name, item_name, group
     )
 
-    ctx.obj.set_scene_item_enabled(
+    ctx.obj['obsws'].set_scene_item_enabled(
         scene_name=scene_name,
         item_id=int(scene_item_id),
         enabled=True,
@@ -213,7 +218,8 @@ def show(
 
     if group:
         console.out.print(
-            f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been shown.'
+            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
@@ -221,7 +227,7 @@ def show(
         # which is not the same as the scene name
         # and is not needed in this case
         console.out.print(
-            f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been shown.'
+            f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been shown.'
         )
 
 
@@ -246,7 +252,7 @@ def hide(
         ctx, scene_name, item_name, group
     )
 
-    ctx.obj.set_scene_item_enabled(
+    ctx.obj['obsws'].set_scene_item_enabled(
         scene_name=scene_name,
         item_id=int(scene_item_id),
         enabled=False,
@@ -254,7 +260,7 @@ def hide(
 
     if group:
         console.out.print(
-            f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been hidden.'
+            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
@@ -262,7 +268,7 @@ def hide(
         # which is not the same as the scene name
         # and is not needed in this case
         console.out.print(
-            f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been hidden.'
+            f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been hidden.'
         )
 
 
@@ -289,13 +295,13 @@ def toggle(
         ctx, scene_name, item_name, group
     )
 
-    enabled = ctx.obj.get_scene_item_enabled(
+    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.set_scene_item_enabled(
+    ctx.obj['obsws'].set_scene_item_enabled(
         scene_name=scene_name,
         item_id=int(scene_item_id),
         enabled=new_state,
@@ -304,11 +310,13 @@ def toggle(
     if group:
         if new_state:
             console.out.print(
-                f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been shown.'
+                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 [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been hidden.'
+                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
@@ -317,11 +325,11 @@ def toggle(
         # and is not needed in this case
         if new_state:
             console.out.print(
-                f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been shown.'
+                f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been shown.'
             )
         else:
             console.out.print(
-                f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been hidden.'
+                f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been hidden.'
             )
 
 
@@ -348,14 +356,15 @@ def visible(
         ctx, scene_name, item_name, group
     )
 
-    enabled = ctx.obj.get_scene_item_enabled(
+    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 [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] is currently {"visible" if enabled.scene_item_enabled else "hidden"}.'
+            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
@@ -363,7 +372,8 @@ def visible(
         # which is not the same as the scene name
         # and is not needed in this case
         console.out.print(
-            f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] is currently {"visible" if enabled.scene_item_enabled else "hidden"}.'
+            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"}.'
         )
 
 
@@ -471,7 +481,7 @@ def transform(
         console.err.print('No transform options provided.')
         raise typer.Exit(1)
 
-    transform = ctx.obj.set_scene_item_transform(
+    transform = ctx.obj['obsws'].set_scene_item_transform(
         scene_name=scene_name,
         item_id=int(scene_item_id),
         transform=transform,
@@ -479,7 +489,8 @@ def transform(
 
     if group:
         console.out.print(
-            f'Item [green]{item_name}[/green] in group [green]{group}[/green] in scene [green]{old_scene_name}[/green] has been transformed.'
+            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
@@ -487,5 +498,5 @@ def transform(
         # which is not the same as the scene name
         # and is not needed in this case
         console.out.print(
-            f'Item [green]{item_name}[/green] in scene [green]{scene_name}[/green] has been transformed.'
+            f'Item {console.highlight(ctx, item_name)} in scene {console.highlight(ctx, scene_name)} has been transformed.'
         )

obsws_cli/screenshot.py

@@ -63,7 +63,7 @@ def save(
 ):
     """Take a screenshot and save it to a file."""
     try:
-        ctx.obj.save_source_screenshot(
+        ctx.obj['obsws'].save_source_screenshot(
             name=source_name,
             img_format=output_path.suffix.lstrip('.').lower(),
             file_path=str(output_path),
@@ -87,4 +87,4 @@ def save(
             case _:
                 raise
 
-    console.out.print(f'Screenshot saved to [green]{output_path}[/green].')
+    console.out.print(f'Screenshot saved to {console.highlight(ctx, output_path)}.')

obsws_cli/settings.py

@@ -16,6 +16,7 @@ class Settings(UserDict):
     The settings are expected to be in uppercase and should start with 'OBS_'.
 
     Example:
+    -------
         settings = Settings()
         host = settings['OBS_HOST']
         settings['OBS_PORT'] = 4455
@@ -55,6 +56,8 @@ _settings = Settings(
     OBS_PASSWORD='',
     OBS_TIMEOUT=5,
     OBS_DEBUG=False,
+    OBS_STYLE='disabled',
+    OBS_STYLE_NO_BORDER=False,
 )
 
 
@@ -62,12 +65,15 @@ def get(key: str) -> SettingsValue:
     """Get a setting value by key.
 
     Args:
+    ----
         key (str): The key of the setting to retrieve.
 
     Returns:
+    -------
         The value of the setting.
 
     Raises:
+    ------
         KeyError: If the key does not exist in the settings.
 
     """

obsws_cli/stream.py

@@ -15,7 +15,7 @@ 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
 
 
@@ -27,7 +27,7 @@ def start(ctx: typer.Context):
         console.err.print('Streaming is already in progress, cannot start.')
         raise typer.Exit(1)
 
-    ctx.obj.start_stream()
+    ctx.obj['obsws'].start_stream()
     console.out.print('Streaming started successfully.')
 
 
@@ -39,14 +39,14 @@ def stop(ctx: typer.Context):
         console.err.print('Streaming is not in progress, cannot stop.')
         raise typer.Exit(1)
 
-    ctx.obj.stop_stream()
+    ctx.obj['obsws'].stop_stream()
     console.out.print('Streaming stopped successfully.')
 
 
 @app.command('toggle | tg')
 def toggle(ctx: typer.Context):
     """Toggle streaming."""
-    resp = ctx.obj.toggle_stream()
+    resp = ctx.obj['obsws'].toggle_stream()
     if resp.output_active:
         console.out.print('Streaming started successfully.')
     else:

obsws_cli/studiomode.py

@@ -16,33 +16,33 @@ def main():
 @app.command('enable | on')
 def enable(ctx: typer.Context):
     """Enable studio mode."""
-    ctx.obj.set_studio_mode_enabled(True)
+    ctx.obj['obsws'].set_studio_mode_enabled(True)
     console.out.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)
+    ctx.obj['obsws'].set_studio_mode_enabled(False)
     console.out.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()
+    resp = ctx.obj['obsws'].get_studio_mode_enabled()
     if resp.studio_mode_enabled:
-        ctx.obj.set_studio_mode_enabled(False)
+        ctx.obj['obsws'].set_studio_mode_enabled(False)
         console.out.print('Studio mode is now disabled.')
     else:
-        ctx.obj.set_studio_mode_enabled(True)
+        ctx.obj['obsws'].set_studio_mode_enabled(True)
         console.out.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()
+    resp = ctx.obj['obsws'].get_studio_mode_enabled()
     if resp.studio_mode_enabled:
         console.out.print('Studio mode is enabled.')
     else:

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/text.py

@@ -0,0 +1,78 @@
+"""module containing commands for manipulating text inputs."""
+
+from typing import Annotated, Optional
+
+import typer
+
+from . import console, validate
+from .alias import SubTyperAliasGroup
+
+app = typer.Typer(cls=SubTyperAliasGroup)
+
+
+@app.callback()
+def main():
+    """Control text inputs in OBS."""
+
+
+@app.command('current | get')
+def current(
+    ctx: typer.Context,
+    input_name: Annotated[str, typer.Argument(help='Name of the text input to get.')],
+):
+    """Get the current text for a text input."""
+    if not validate.input_in_inputs(ctx, input_name):
+        console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
+        raise typer.Exit(1)
+
+    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 | set')
+def update(
+    ctx: typer.Context,
+    input_name: Annotated[
+        str, typer.Argument(help='Name of the text input to update.')
+    ],
+    new_text: Annotated[
+        Optional[str],
+        typer.Argument(
+            help='The new text to set for the input.',
+        ),
+    ] = None,
+):
+    """Update the text of a text input."""
+    if not validate.input_in_inputs(ctx, input_name):
+        console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
+        raise typer.Exit(1)
+
+    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/util.py

@@ -13,6 +13,10 @@ def check_mark(value: bool, empty_if_false: bool = False) -> str:
     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 '❌'

obsws_cli/validate.py

@@ -8,19 +8,19 @@ skipped_option = typer.Option(parser=lambda _: _, hidden=True, expose_value=Fals
 
 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
+    inputs = ctx.obj['obsws'].get_input_list().inputs
     return any(input_.get('inputName') == input_name for input_ in inputs)
 
 
 def scene_in_scenes(ctx: typer.Context, scene_name: str) -> bool:
     """Check if a scene exists in the list of scenes."""
-    resp = ctx.obj.get_scene_list()
+    resp = ctx.obj['obsws'].get_scene_list()
     return any(scene.get('sceneName') == scene_name for scene in resp.scenes)
 
 
 def studio_mode_enabled(ctx: typer.Context) -> bool:
     """Check if studio mode is enabled."""
-    resp = ctx.obj.get_studio_mode_enabled()
+    resp = ctx.obj['obsws'].get_studio_mode_enabled()
     return resp.studio_mode_enabled
 
 
@@ -28,7 +28,7 @@ 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()
+    resp = ctx.obj['obsws'].get_scene_collection_list()
     return any(
         collection == scene_collection_name for collection in resp.scene_collections
     )
@@ -38,17 +38,17 @@ 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()
+    resp = ctx.obj['obsws'].get_profile_list()
     return any(profile == profile_name for profile in resp.profiles)
 
 
 def monitor_exists(ctx: typer.Context, monitor_index: int) -> bool:
     """Check if a monitor exists."""
-    resp = ctx.obj.get_monitor_list()
+    resp = ctx.obj['obsws'].get_monitor_list()
     return any(monitor['monitorIndex'] == monitor_index for monitor in resp.monitors)

obsws_cli/virtualcam.py

@@ -16,21 +16,21 @@ def main():
 @app.command('start | s')
 def start(ctx: typer.Context):
     """Start the virtual camera."""
-    ctx.obj.start_virtual_cam()
+    ctx.obj['obsws'].start_virtual_cam()
     console.out.print('Virtual camera started.')
 
 
 @app.command('stop | p')
 def stop(ctx: typer.Context):
     """Stop the virtual camera."""
-    ctx.obj.stop_virtual_cam()
+    ctx.obj['obsws'].stop_virtual_cam()
     console.out.print('Virtual camera stopped.')
 
 
 @app.command('toggle | tg')
 def toggle(ctx: typer.Context):
     """Toggle the virtual camera."""
-    resp = ctx.obj.toggle_virtual_cam()
+    resp = ctx.obj['obsws'].toggle_virtual_cam()
     if resp.output_active:
         console.out.print('Virtual camera is enabled.')
     else:
@@ -40,7 +40,7 @@ def toggle(ctx: typer.Context):
 @app.command('status | ss')
 def status(ctx: typer.Context):
     """Get the status of the virtual camera."""
-    resp = ctx.obj.get_virtual_cam_status()
+    resp = ctx.obj['obsws'].get_virtual_cam_status()
     if resp.output_active:
         console.out.print('Virtual camera is enabled.')
     else:

pyproject.toml

@@ -21,7 +21,7 @@ classifiers = [
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
-dependencies = ["typer>=0.16.0", "obsws-python>=1.7.2", "python-dotenv>=1.1.0"]
+dependencies = ["typer>=0.16.0", "obsws-python>=1.8.0", "python-dotenv>=1.1.0"]
 
 
 [project.urls]

tests/conftest.py

@@ -71,6 +71,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':

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(mix_stderr=False)
+
+
+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