print message and return 0 for list queries returning empty results

add descriptions for filter + scene command groups

Usage now after main CLI description

obsws_cli/__init__.py

@@ -2,6 +2,6 @@
 #
 # SPDX-License-Identifier: MIT
 
-from .app import app
+from .app import run
 
-__all__ = ['app']
+__all__ = ['run']

obsws_cli/alias.py

@@ -1,73 +0,0 @@
-"""module defining a custom group class for handling command name aliases."""
-
-import re
-
-import typer
-
-
-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."""
-        super().__init__(*args, **kwargs)
-        self.no_args_is_help = True
-
-    def get_command(self, ctx, cmd_name):
-        """Get a command by 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 '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 '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)
-
-
-class SubTyperAliasGroup(typer.core.TyperGroup):
-    """A custom group class to handle command name aliases for sub typers."""
-
-    _CMD_SPLIT_P = re.compile(r' ?[,|] ?')
-
-    def __init__(self, *args, **kwargs):
-        """Initialize the AliasGroup."""
-        super().__init__(*args, **kwargs)
-        self.no_args_is_help = True
-
-    def get_command(self, ctx, cmd_name):
-        """Get a command by name."""
-        cmd_name = self._group_cmd_name(cmd_name)
-        return super().get_command(ctx, cmd_name)
-
-    def _group_cmd_name(self, default_name):
-        for cmd in self.commands.values():
-            if cmd.name and default_name in self._CMD_SPLIT_P.split(cmd.name):
-                return cmd.name
-        return default_name

obsws_cli/app.py

@@ -2,18 +2,27 @@
 
 import importlib
 import logging
-from typing import Annotated
+from dataclasses import dataclass
+from typing import Annotated, Any
 
 import obsws_python as obsws
-import typer
+from cyclopts import App, Group, Parameter, config
 
 from obsws_cli.__about__ import __version__ as version
 
-from . import console, settings, styles
+from . import console, styles
-from .alias import RootTyperAliasGroup
+from .context import Context
+from .error import OBSWSCLIError
 
-app = typer.Typer(cls=RootTyperAliasGroup)
+app = App(
-for sub_typer in (
+    config=config.Env(
+        'OBS_'
+    ),  # Environment variable prefix for configuration parameters
+    version=version,
+    usage='[bold][yellow]Usage:[/yellow] [white]obsws-cli [OPTIONS] COMMAND [ARGS]...[/white][/bold]',
+)
+app.meta.group_parameters = Group('Options', sort_key=0)
+for sub_app in (
     'filter',
     'group',
     'hotkey',
@@ -31,135 +40,98 @@ for sub_typer in (
     'text',
     'virtualcam',
 ):
-    module = importlib.import_module(f'.{sub_typer}', package=__package__)
+    module = importlib.import_module(f'.{sub_app}', package=__package__)
-    app.add_typer(module.app, name=sub_typer)
+    app.command(module.app)
 
 
-def version_callback(value: bool):
+@Parameter(name='*')
-    """Show the version of the CLI."""
+@dataclass
-    if value:
+class OBSConfig:
-        console.out.print(f'obsws-cli version: {version}')
+    """Dataclass to hold OBS connection parameters.
-        raise typer.Exit()
+
+    Attributes:
+        host (str): The hostname or IP address of the OBS WebSocket server.
+        port (int): The port number of the OBS WebSocket server.
+        password (str): The password for the OBS WebSocket server, if required.
+
+    """
+
+    host: str = 'localhost'
+    port: int = 4455
+    password: str = ''
 
 
-def setup_logging(debug: bool):
+@dataclass
+class StyleConfig:
+    """Dataclass to hold style parameters.
+
+    Attributes:
+        name (str): The name of the style to use for console output.
+        no_border (bool): Whether to style the borders in the console output.
+
+    """
+
+    name: str = 'disabled'
+    no_border: bool = False
+
+
+def setup_logging(type_, value: Any):
     """Set up logging for the application."""
-    log_level = logging.DEBUG if debug else logging.CRITICAL
+    log_level = logging.DEBUG if value else logging.CRITICAL
     logging.basicConfig(
         level=log_level,
         format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
     )
 
 
-def validate_style(value: str):
+@app.meta.default
-    """Validate and return the style."""
+def launcher(
-    if value not in styles.registry:
+    *tokens: Annotated[str, Parameter(show=False, allow_leading_hyphen=True)],
-        raise typer.BadParameter(
+    obs_config: OBSConfig,
-            f'Invalid style: {value}. Available styles: {", ".join(styles.registry.keys())}'
+    style_config: StyleConfig,
-        )
-    return value
-
-
-@app.callback()
-def main(
-    ctx: typer.Context,
-    host: Annotated[
-        str,
-        typer.Option(
-            '--host',
-            '-H',
-            envvar='OBS_HOST',
-            help='WebSocket host',
-            show_default='localhost',
-        ),
-    ] = settings.get('host'),
-    port: Annotated[
-        int,
-        typer.Option(
-            '--port',
-            '-P',
-            envvar='OBS_PORT',
-            help='WebSocket port',
-            show_default=4455,
-        ),
-    ] = settings.get('port'),
-    password: Annotated[
-        str,
-        typer.Option(
-            '--password',
-            '-p',
-            envvar='OBS_PASSWORD',
-            help='WebSocket password',
-            show_default=False,
-        ),
-    ] = settings.get('password'),
-    timeout: Annotated[
-        int,
-        typer.Option(
-            '--timeout',
-            '-T',
-            envvar='OBS_TIMEOUT',
-            help='WebSocket timeout',
-            show_default=5,
-        ),
-    ] = settings.get('timeout'),
-    version: Annotated[
-        bool,
-        typer.Option(
-            '--version',
-            '-v',
-            is_eager=True,
-            help='Show the CLI version and exit',
-            show_default=False,
-            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(
+        Parameter(validator=setup_logging, help='Enable debug logging'),
-            '--debug',
+    ] = False,
-            '-d',
-            envvar='OBS_DEBUG',
-            is_eager=True,
-            help='Enable debug logging',
-            show_default=False,
-            callback=setup_logging,
-            hidden=True,
-        ),
-    ] = settings.get('debug'),
 ):
-    """obsws_cli is a command line interface for the OBS WebSocket API."""
+    """Command line interface for the OBS WebSocket API."""
-    ctx.ensure_object(dict)
+    with obsws.ReqClient(
-    ctx.obj['obsws'] = ctx.with_resource(obsws.ReqClient(**ctx.params))
+        host=obs_config.host,
-    ctx.obj['style'] = styles.request_style_obj(style, no_border)
+        port=obs_config.port,
+        password=obs_config.password,
+    ) as client:
+        additional_kwargs = {}
+        command, bound, ignored = app.parse_args(tokens)
+        if 'ctx' in ignored:
+            # If 'ctx' is in ignored, it means it was not passed as an argument
+            # and we need to add it to the bound arguments.
+            additional_kwargs['ctx'] = ignored['ctx'](
+                client,
+                styles.request_style_obj(style_config.name, style_config.no_border),
+            )
+        return command(*bound.args, **bound.kwargs, **additional_kwargs)
 
 
-@app.command()
+@app.command
-def obs_version(ctx: typer.Context):
+def obs_version(
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
     """Get the OBS Client and WebSocket versions."""
-    resp = ctx.obj['obsws'].get_version()
+    resp = ctx.client.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)}'
     )
+
+
+def run():
+    """Run the OBS WebSocket CLI application.
+
+    Handles exceptions and prints error messages to the console.
+    """
+    try:
+        app.meta()
+    except OBSWSCLIError as e:
+        console.err.print(f'Error: {e}')
+        return e.code

obsws_cli/console.py

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

obsws_cli/context.py

@@ -0,0 +1,15 @@
+"""module for managing the application context."""
+
+from dataclasses import dataclass
+
+import obsws_python as obsws
+
+from . import styles
+
+
+@dataclass
+class Context:
+    """Context for the application, holding OBS and style configurations."""
+
+    client: obsws.ReqClient
+    style: styles.Style

obsws_cli/enum.py

@@ -0,0 +1,10 @@
+"""module for exit codes used in the application."""
+
+from enum import IntEnum, auto
+
+
+class ExitCode(IntEnum):
+    """Exit codes for the application."""
+
+    SUCCESS = 0
+    ERROR = auto()

obsws_cli/error.py

@@ -0,0 +1,11 @@
+"""module containing error handling for OBS WebSocket CLI."""
+
+
+class OBSWSCLIError(Exception):
+    """Base class for OBS WebSocket CLI errors."""
+
+    def __init__(self, message: str, code: int = 1):
+        """Initialize the error with a message and an optional code."""
+        super().__init__(message)
+        self.message = message
+        self.code = code

obsws_cli/filter.py

@@ -3,44 +3,46 @@
 from typing import Annotated, Optional
 
 import obsws_python as obsws
-import typer
+from cyclopts import App, Parameter
 from rich.table import Table
 from rich.text import Text
 
 from . import console, util
-from .alias import SubTyperAliasGroup
+from .context import Context
+from .enum import ExitCode
+from .error import OBSWSCLIError
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(name='filter', help='Commands for managing filters in OBS sources')
 
 
-@app.callback()
+@app.command(name=['list', 'ls'])
-def main():
-    """Control filters in OBS scenes."""
-
-
-@app.command('list | ls')
 def list_(
-    ctx: typer.Context,
+    source_name: Optional[str] = None,
-    source_name: Annotated[
+    /,
-        Optional[str],
+    *,
-        typer.Argument(
+    ctx: Annotated[Context, Parameter(parse=False)],
-            show_default='The current scene',
-            help='The source to list filters for',
-        ),
-    ] = None,
 ):
-    """List filters for a source."""
+    """List filters for a source.
+
+    Parameters
+    ----------
+    source_name : str, optional
+        The name of the source to list filters for. If not provided, the current program scene's source will be used.
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
     if not source_name:
-        source_name = ctx.obj['obsws'].get_current_program_scene().scene_name
+        source_name = ctx.client.get_current_program_scene().scene_name
 
     try:
-        resp = ctx.obj['obsws'].get_source_filter_list(source_name)
+        resp = ctx.client.get_source_filter_list(source_name)
     except obsws.error.OBSSDKRequestError as e:
         if e.code == 600:
-            console.err.print(
+            raise OBSWSCLIError(
-                f'No source was found by the name of [yellow]{source_name}[/yellow].'
+                f'No source found by the name of [yellow]{source_name}[/yellow].',
+                code=ExitCode.ERROR,
             )
-            raise typer.Exit(1)
         else:
             raise
 
@@ -48,25 +50,25 @@ def list_(
         console.out.print(
             f'No filters found for source {console.highlight(ctx, source_name)}'
         )
-        raise typer.Exit()
+        return
 
     table = Table(
         title=f'Filters for Source: {source_name}',
         padding=(0, 2),
-        border_style=ctx.obj['style'].border,
+        border_style=ctx.style.border,
     )
 
     columns = [
-        (Text('Filter Name', justify='center'), 'left', ctx.obj['style'].column),
+        (Text('Filter Name', justify='center'), 'left', ctx.style.column),
-        (Text('Kind', justify='center'), 'left', ctx.obj['style'].column),
+        (Text('Kind', justify='center'), 'left', ctx.style.column),
         (Text('Enabled', justify='center'), 'center', None),
-        (Text('Settings', justify='center'), 'center', ctx.obj['style'].column),
+        (Text('Settings', justify='center'), 'center', ctx.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'])
+        resp = ctx.client.get_source_filter_default_settings(filter['filterKind'])
         settings = resp.default_filter_settings | filter['filterSettings']
 
         table.add_row(
@@ -84,93 +86,100 @@ def list_(
     console.out.print(table)
 
 
-def _get_filter_enabled(ctx: typer.Context, source_name: str, filter_name: str):
+def _get_filter_enabled(ctx: 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)
+    resp = ctx.client.get_source_filter(source_name, filter_name)
     return resp.filter_enabled
 
 
-@app.command('enable | on')
+@app.command(name=['enable', 'on'])
 def enable(
-    ctx: typer.Context,
+    source_name: str,
-    source_name: Annotated[
+    filter_name: str,
-        str,
+    /,
-        typer.Argument(
+    *,
-            ..., show_default=False, help='The source to enable the filter for'
+    ctx: Annotated[Context, Parameter(parse=False)],
-        ),
-    ],
-    filter_name: Annotated[
-        str,
-        typer.Argument(
-            ..., show_default=False, help='The name of the filter to enable'
-        ),
-    ],
 ):
-    """Enable a filter for a source."""
+    """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)
+    Parameters
+    ----------
+    source_name : str
+        The name of the source to enable the filter for.
+    filter_name : str
+        The name of the filter to enable.
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
+    if _get_filter_enabled(ctx, source_name, filter_name):
+        raise OBSWSCLIError(
+            f'Filter [yellow]{filter_name}[/yellow] is already enabled for source [yellow]{source_name}[/yellow]',
+            code=ExitCode.ERROR,
+        )
+
+    ctx.client.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 | off')
+@app.command(name=['disable', 'off'])
 def disable(
-    ctx: typer.Context,
+    source_name: str,
-    source_name: Annotated[
+    filter_name: str,
-        str,
+    /,
-        typer.Argument(
+    *,
-            ..., show_default=False, help='The source to disable the filter for'
+    ctx: Annotated[Context, Parameter(parse=False)],
-        ),
-    ],
-    filter_name: Annotated[
-        str,
-        typer.Argument(
-            ..., show_default=False, help='The name of the filter to disable'
-        ),
-    ],
 ):
-    """Disable a filter for a source."""
+    """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)
+    Parameters
+    ----------
+    source_name : str
+        The name of the source to disable the filter for.
+    filter_name : str
+        The name of the filter to disable.
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
+    if not _get_filter_enabled(ctx, source_name, filter_name):
+        raise OBSWSCLIError(
+            f'Filter [yellow]{filter_name}[/yellow] is already disabled for source [yellow]{source_name}[/yellow]',
+            code=ExitCode.ERROR,
+        )
+
+    ctx.client.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 | tg')
+@app.command(name=['toggle', 'tg'])
 def toggle(
-    ctx: typer.Context,
+    source_name: str,
-    source_name: Annotated[
+    filter_name: str,
-        str,
+    /,
-        typer.Argument(
+    *,
-            ..., show_default=False, help='The source to toggle the filter for'
+    ctx: Annotated[Context, Parameter(parse=False)],
-        ),
-    ],
-    filter_name: Annotated[
-        str,
-        typer.Argument(
-            ..., show_default=False, help='The name of the filter to toggle'
-        ),
-    ],
 ):
-    """Toggle a filter for a source."""
+    """Toggle a filter for a source.
+
+    Parameters
+    ----------
+    source_name : str
+        The name of the source to toggle the filter for.
+    filter_name : str
+        The name of the filter to toggle.
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
     is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
     new_state = not is_enabled
 
-    ctx.obj['obsws'].set_source_filter_enabled(
+    ctx.client.set_source_filter_enabled(source_name, filter_name, enabled=new_state)
-        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)}'
@@ -181,23 +190,26 @@ def toggle(
         )
 
 
-@app.command('status | ss')
+@app.command(name=['status', 'ss'])
 def status(
-    ctx: typer.Context,
+    source_name: str,
-    source_name: Annotated[
+    filter_name: str,
-        str,
+    /,
-        typer.Argument(
+    *,
-            ..., show_default=False, help='The source to get the filter status for'
+    ctx: Annotated[Context, Parameter(parse=False)],
-        ),
-    ],
-    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."""
+    """Get the status of a filter for a source.
+
+    Parameters
+    ----------
+    source_name : str
+        The name of the source to check the filter status for.
+    filter_name : str
+        The name of the filter to check the status for.
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
     is_enabled = _get_filter_enabled(ctx, source_name, filter_name)
     if is_enabled:
         console.out.print(

obsws_cli/group.py

@@ -2,42 +2,47 @@
 
 from typing import Annotated, Optional
 
-import typer
+from cyclopts import App, Parameter
 from rich.table import Table
 from rich.text import Text
 
 from . import console, util, validate
-from .alias import SubTyperAliasGroup
+from .context import Context
+from .enum import ExitCode
+from .error import OBSWSCLIError
 from .protocols import DataclassProtocol
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(name='group', help='Commands for managing groups in OBS scenes')
 
 
-@app.callback()
+@app.command(name=['list', 'ls'])
-def main():
-    """Control groups in OBS scenes."""
-
-
-@app.command('list | ls')
 def list_(
-    ctx: typer.Context,
+    scene_name: Optional[str] = None,
-    scene_name: Annotated[
+    /,
-        Optional[str],
+    *,
-        typer.Argument(
+    ctx: Annotated[Context, Parameter(parse=False)],
-            show_default='The current scene',
-            help='Scene name to list groups for',
-        ),
-    ] = None,
 ):
-    """List groups in a scene."""
+    """List groups in a scene.
+
+    Parameters
+    ----------
+    scene_name : str, optional
+        The name of the scene to list groups for. If not provided, the current program scene
+        will be used.
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
     if not scene_name:
-        scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
+        scene_name = ctx.client.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 OBSWSCLIError(
-        raise typer.Exit(1)
+            f'Scene [yellow]{scene_name}[/yellow] not found.',
+            code=ExitCode.ERROR,
+        )
 
-    resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
+    resp = ctx.client.get_scene_item_list(scene_name)
     groups = [
         (item.get('sceneItemId'), item.get('sourceName'), item.get('sceneItemEnabled'))
         for item in resp.scene_items
@@ -48,17 +53,17 @@ def list_(
         console.out.print(
             f'No groups found in scene {console.highlight(ctx, scene_name)}.'
         )
-        raise typer.Exit()
+        return
 
     table = Table(
         title=f'Groups in Scene: {scene_name}',
         padding=(0, 2),
-        border_style=ctx.obj['style'].border,
+        border_style=ctx.style.border,
     )
 
     columns = [
-        (Text('ID', justify='center'), 'center', ctx.obj['style'].column),
+        (Text('ID', justify='center'), 'center', ctx.style.column),
-        (Text('Group Name', justify='center'), 'left', ctx.obj['style'].column),
+        (Text('Group Name', justify='center'), 'left', ctx.style.column),
         (Text('Enabled', justify='center'), 'center', None),
     ]
     for heading, justify, style in columns:
@@ -87,30 +92,40 @@ def _get_group(group_name: str, resp: DataclassProtocol) -> dict | None:
     return group
 
 
-@app.command('show | sh')
+@app.command(name=['show', 'sh'])
 def show(
-    ctx: typer.Context,
+    scene_name: str,
-    scene_name: Annotated[
+    group_name: str,
-        str,
+    /,
-        typer.Argument(..., show_default=False, help='Scene name the group is in'),
+    *,
-    ],
+    ctx: Annotated[Context, Parameter(parse=False)],
-    group_name: Annotated[
-        str, typer.Argument(..., show_default=False, help='Group name to show')
-    ],
 ):
-    """Show a group in a scene."""
+    """Show a group in a scene.
+
+    Parameters
+    ----------
+    scene_name : str
+        The name of the scene where the group is located.
+    group_name : str
+        The name of the group to show.
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
     if not validate.scene_in_scenes(ctx, scene_name):
-        console.err.print(f"Scene '{scene_name}' not found.")
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            f'Scene [yellow]{scene_name}[/yellow] not found.',
-
+            code=ExitCode.ERROR,
-    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(
+    resp = ctx.client.get_scene_item_list(scene_name)
+    if (group := _get_group(group_name, resp)) is None:
+        raise OBSWSCLIError(
+            f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].',
+            code=ExitCode.ERROR,
+        )
+
+    ctx.client.set_scene_item_enabled(
         scene_name=scene_name,
         item_id=int(group.get('sceneItemId')),
         enabled=True,
@@ -119,29 +134,40 @@ def show(
     console.out.print(f'Group {console.highlight(ctx, group_name)} is now visible.')
 
 
-@app.command('hide | h')
+@app.command(name=['hide', 'h'])
 def hide(
-    ctx: typer.Context,
+    scene_name: str,
-    scene_name: Annotated[
+    group_name: str,
-        str, typer.Argument(..., show_default=False, help='Scene name the group is in')
+    /,
-    ],
+    *,
-    group_name: Annotated[
+    ctx: Annotated[Context, Parameter(parse=False)],
-        str, typer.Argument(..., show_default=False, help='Group name to hide')
-    ],
 ):
-    """Hide a group in a scene."""
+    """Hide a group in a scene.
+
+    Parameters
+    ----------
+    scene_name : str
+        The name of the scene where the group is located.
+    group_name : str
+        The name of the group to hide.
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
     if not validate.scene_in_scenes(ctx, scene_name):
-        console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            f'Scene [yellow]{scene_name}[/yellow] not found.',
-
+            code=ExitCode.ERROR,
-    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(
+    resp = ctx.client.get_scene_item_list(scene_name)
+    if (group := _get_group(group_name, resp)) is None:
+        raise OBSWSCLIError(
+            f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].',
+            code=ExitCode.ERROR,
+        )
+
+    ctx.client.set_scene_item_enabled(
         scene_name=scene_name,
         item_id=int(group.get('sceneItemId')),
         enabled=False,
@@ -150,30 +176,41 @@ def hide(
     console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
 
 
-@app.command('toggle | tg')
+@app.command(name=['toggle', 'tg'])
 def toggle(
-    ctx: typer.Context,
+    scene_name: str,
-    scene_name: Annotated[
+    group_name: str,
-        str, typer.Argument(..., show_default=False, help='Scene name the group is in')
+    /,
-    ],
+    *,
-    group_name: Annotated[
+    ctx: Annotated[Context, Parameter(parse=False)],
-        str, typer.Argument(..., show_default=False, help='Group name to toggle')
-    ],
 ):
-    """Toggle a group in a scene."""
+    """Toggle a group in a scene.
-    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['obsws'].get_scene_item_list(scene_name)
+    Parameters
-    if (group := _get_group(group_name, resp)) is None:
+    ----------
-        console.err.print(
+    scene_name : str
-            f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
+        The name of the scene where the group is located.
+    group_name : str
+        The name of the group to toggle.
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
+    if not validate.scene_in_scenes(ctx, scene_name):
+        raise OBSWSCLIError(
+            f'Scene [yellow]{scene_name}[/yellow] not found.',
+            code=ExitCode.ERROR,
+        )
+
+    resp = ctx.client.get_scene_item_list(scene_name)
+    if (group := _get_group(group_name, resp)) is None:
+        raise OBSWSCLIError(
+            f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].',
+            code=ExitCode.ERROR,
         )
-        raise typer.Exit(1)
 
     new_state = not group.get('sceneItemEnabled')
-    ctx.obj['obsws'].set_scene_item_enabled(
+    ctx.client.set_scene_item_enabled(
         scene_name=scene_name,
         item_id=int(group.get('sceneItemId')),
         enabled=new_state,
@@ -185,29 +222,40 @@ def toggle(
         console.out.print(f'Group {console.highlight(ctx, group_name)} is now hidden.')
 
 
-@app.command('status | ss')
+@app.command(name=['status', 'ss'])
 def status(
-    ctx: typer.Context,
+    scene_name: str,
-    scene_name: Annotated[
+    group_name: str,
-        str, typer.Argument(..., show_default=False, help='Scene name the group is in')
+    /,
-    ],
+    *,
-    group_name: Annotated[
+    ctx: Annotated[Context, Parameter(parse=False)],
-        str, typer.Argument(..., show_default=False, help='Group name to check status')
-    ],
 ):
-    """Get the status of a group in a scene."""
+    """Get the status of a group in a scene.
+
+    Parameters
+    ----------
+    scene_name : str
+        The name of the scene where the group is located.
+    group_name : str
+        The name of the group to check.
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
     if not validate.scene_in_scenes(ctx, scene_name):
-        console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            f'Scene [yellow]{scene_name}[/yellow] not found.',
-
+            code=ExitCode.ERROR,
-    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(
+    resp = ctx.client.get_scene_item_list(scene_name)
+    if (group := _get_group(group_name, resp)) is None:
+        raise OBSWSCLIError(
+            f'Group [yellow]{group_name}[/yellow] not found in scene [yellow]{scene_name}[/yellow].',
+            code=ExitCode.ERROR,
+        )
+
+    enabled = ctx.client.get_scene_item_enabled(
         scene_name=scene_name,
         item_id=int(group.get('sceneItemId')),
     )

obsws_cli/hotkey.py

@@ -2,37 +2,40 @@
 
 from typing import Annotated
 
-import typer
+from cyclopts import App, Parameter
 from rich.table import Table
 from rich.text import Text
 
 from . import console
-from .alias import SubTyperAliasGroup
+from .context import Context
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(name='hotkey', help='Commands for managing hotkeys in OBS')
 
 
-@app.callback()
+@app.command(name=['list', 'ls'])
-def main():
-    """Control hotkeys in OBS."""
-
-
-@app.command('list | ls')
 def list_(
-    ctx: typer.Context,
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
 ):
-    """List all hotkeys."""
+    """List all hotkeys.
-    resp = ctx.obj['obsws'].get_hotkey_list()
+
+    Parameters
+    ----------
+    ctx : Context
+        The context containing the OBS client to interact with.
+
+    """
+    resp = ctx.client.get_hotkey_list()
 
     table = Table(
         title='Hotkeys',
         padding=(0, 2),
-        border_style=ctx.obj['style'].border,
+        border_style=ctx.style.border,
     )
     table.add_column(
         Text('Hotkey Name', justify='center'),
         justify='left',
-        style=ctx.obj['style'].column,
+        style=ctx.style.column,
     )
 
     for i, hotkey in enumerate(resp.hotkeys):
@@ -41,40 +44,53 @@ def list_(
     console.out.print(table)
 
 
-@app.command('trigger | tr')
+@app.command(name=['trigger', 'tr'])
 def trigger(
-    ctx: typer.Context,
+    hotkey: str,
-    hotkey: Annotated[
+    /,
-        str, typer.Argument(..., show_default=False, help='The hotkey to trigger')
+    *,
-    ],
+    ctx: Annotated[Context, Parameter(parse=False)],
 ):
-    """Trigger a hotkey by name."""
+    """Trigger a hotkey by name.
-    ctx.obj['obsws'].trigger_hotkey_by_name(hotkey)
+
+    Parameters
+    ----------
+    hotkey : str
+        The name of the hotkey to trigger.
+    ctx : Context
+        The context containing the OBS client to interact with.
+
+    """
+    ctx.client.trigger_hotkey_by_name(hotkey)
 
 
-@app.command('trigger-sequence | trs')
+@app.command(name=['trigger-sequence', 'trs'])
 def trigger_sequence(
-    ctx: typer.Context,
+    key_id: str,
-    key_id: Annotated[
+    /,
-        str,
+    shift: bool = False,
-        typer.Argument(
+    ctrl: bool = False,
-            ...,
+    alt: bool = False,
-            show_default=False,
+    cmd: bool = 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',
+    *,
-        ),
+    ctx: Annotated[Context, Parameter(parse=False)],
-    ],
-    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."""
+    """Trigger a hotkey by sequence.
-    ctx.obj['obsws'].trigger_hotkey_by_key_sequence(key_id, shift, ctrl, alt, cmd)
+
+    Parameters
+    ----------
+    key_id : str
+        The OBS key ID to trigger, see https://github.com/onyx-and-iris/obsws-cli?tab=readme-ov-file#hotkey for more info
+    shift : bool, optional
+        Press shift when triggering the hotkey (default is False)
+    ctrl : bool, optional
+        Press control when triggering the hotkey (default is False)
+    alt : bool, optional
+        Press alt when triggering the hotkey (default is False)
+    cmd : bool, optional
+        Press cmd when triggering the hotkey (default is False)
+    ctx : Context
+        The context containing the OBS client to interact with.
+
+    """
+    ctx.client.trigger_hotkey_by_key_sequence(key_id, shift, ctrl, alt, cmd)

obsws_cli/input.py

@@ -3,33 +3,50 @@
 from typing import Annotated
 
 import obsws_python as obsws
-import typer
+from cyclopts import App, Parameter
 from rich.table import Table
 from rich.text import Text
 
 from . import console, util, validate
-from .alias import SubTyperAliasGroup
+from .context import Context
+from .enum import ExitCode
+from .error import OBSWSCLIError
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(name='input', help='Commands for managing inputs in OBS')
 
 
-@app.callback()
+@app.command(name=['list', 'ls'])
-def main():
-    """Control inputs in OBS."""
-
-
-@app.command('list | ls')
 def list_(
-    ctx: typer.Context,
+    input: bool = False,
-    input: Annotated[bool, typer.Option(help='Filter by input type.')] = False,
+    output: bool = False,
-    output: Annotated[bool, typer.Option(help='Filter by output type.')] = False,
+    colour: bool = False,
-    colour: Annotated[bool, typer.Option(help='Filter by colour source type.')] = False,
+    ffmpeg: bool = False,
-    ffmpeg: Annotated[bool, typer.Option(help='Filter by ffmpeg source type.')] = False,
+    vlc: bool = False,
-    vlc: Annotated[bool, typer.Option(help='Filter by VLC source type.')] = False,
+    uuid: bool = False,
-    uuid: Annotated[bool, typer.Option(help='Show UUIDs of inputs.')] = False,
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
 ):
-    """List all inputs."""
+    """List all inputs.
-    resp = ctx.obj['obsws'].get_input_list()
+
+    Parameters
+    ----------
+    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.
+    ctx:
+        The context containing the client and style.
+
+    """
+    resp = ctx.client.get_input_list()
 
     kinds = []
     if input:
@@ -43,7 +60,7 @@ def list_(
     if vlc:
         kinds.append('vlc')
     if not any([input, output, colour, ffmpeg, vlc]):
-        kinds = ctx.obj['obsws'].get_input_kind_list(False).input_kinds
+        kinds = ctx.client.get_input_kind_list(False).input_kinds
 
     inputs = sorted(
         (
@@ -57,21 +74,21 @@ def list_(
     )
 
     if not inputs:
-        console.out.print('No inputs found.')
+        console.out.print('No inputs found matching the specified filters.')
-        raise typer.Exit()
+        return
 
-    table = Table(title='Inputs', padding=(0, 2), border_style=ctx.obj['style'].border)
+    table = Table(title='Inputs', padding=(0, 2), border_style=ctx.style.border)
     if uuid:
         columns = [
-            (Text('Input Name', justify='center'), 'left', ctx.obj['style'].column),
+            (Text('Input Name', justify='center'), 'left', ctx.style.column),
-            (Text('Kind', justify='center'), 'center', ctx.obj['style'].column),
+            (Text('Kind', justify='center'), 'center', ctx.style.column),
             (Text('Muted', justify='center'), 'center', None),
-            (Text('UUID', justify='center'), 'left', ctx.obj['style'].column),
+            (Text('UUID', justify='center'), 'left', ctx.style.column),
         ]
     else:
         columns = [
-            (Text('Input Name', justify='center'), 'left', ctx.obj['style'].column),
+            (Text('Input Name', justify='center'), 'left', ctx.style.column),
-            (Text('Kind', justify='center'), 'center', ctx.obj['style'].column),
+            (Text('Kind', justify='center'), 'center', ctx.style.column),
             (Text('Muted', justify='center'), 'center', None),
         ]
     for heading, justify, style in columns:
@@ -80,7 +97,7 @@ def list_(
     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_muted = ctx.client.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
@@ -105,19 +122,30 @@ def list_(
     console.out.print(table)
 
 
-@app.command('mute | m')
+@app.command(name=['mute', 'm'])
 def mute(
-    ctx: typer.Context,
+    input_name: str,
-    input_name: Annotated[
+    /,
-        str, typer.Argument(..., show_default=False, help='Name of the input to mute.')
+    *,
-    ],
+    ctx: Annotated[Context, Parameter(parse=False)],
 ):
-    """Mute an input."""
+    """Mute an 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)
 
-    ctx.obj['obsws'].set_input_mute(
+    Parameters
+    ----------
+    input_name: str
+        Name of the input to mute.
+    ctx: Context
+        The context containing the client and style.
+
+    """
+    if not validate.input_in_inputs(ctx, input_name):
+        raise OBSWSCLIError(
+            f'Input [yellow]{input_name}[/yellow] not found.',
+            code=ExitCode.ERROR,
+        )
+
+    ctx.client.set_input_mute(
         name=input_name,
         muted=True,
     )
@@ -125,20 +153,30 @@ def mute(
     console.out.print(f'Input {console.highlight(ctx, input_name)} muted.')
 
 
-@app.command('unmute | um')
+@app.command(name=['unmute', 'um'])
 def unmute(
-    ctx: typer.Context,
+    input_name: str,
-    input_name: Annotated[
+    /,
-        str,
+    *,
-        typer.Argument(..., show_default=False, help='Name of the input to unmute.'),
+    ctx: Annotated[Context, Parameter(parse=False)],
-    ],
 ):
-    """Unmute an input."""
+    """Unmute an 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)
 
-    ctx.obj['obsws'].set_input_mute(
+    Parameters
+    ----------
+    input_name: str
+        Name of the input to unmute.
+    ctx: Context
+        The context containing the client and style.
+
+    """
+    if not validate.input_in_inputs(ctx, input_name):
+        raise OBSWSCLIError(
+            f'Input [yellow]{input_name}[/yellow] not found.',
+            code=ExitCode.ERROR,
+        )
+
+    ctx.client.set_input_mute(
         name=input_name,
         muted=False,
     )
@@ -146,23 +184,33 @@ def unmute(
     console.out.print(f'Input {console.highlight(ctx, input_name)} unmuted.')
 
 
-@app.command('toggle | tg')
+@app.command(name=['toggle', 'tg'])
 def toggle(
-    ctx: typer.Context,
+    input_name: str,
-    input_name: Annotated[
+    /,
-        str,
+    *,
-        typer.Argument(..., show_default=False, help='Name of the input to toggle.'),
+    ctx: Annotated[Context, Parameter(parse=False)],
-    ],
 ):
-    """Toggle an input."""
+    """Toggle an 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_mute(name=input_name)
+    Parameters
+    ----------
+    input_name: str
+        Name of the input to toggle.
+    ctx: Context
+        The context containing the client and style.
+
+    """
+    if not validate.input_in_inputs(ctx, input_name):
+        raise OBSWSCLIError(
+            f'Input [yellow]{input_name}[/yellow] not found.',
+            code=ExitCode.ERROR,
+        )
+
+    resp = ctx.client.get_input_mute(name=input_name)
     new_state = not resp.input_muted
 
-    ctx.obj['obsws'].set_input_mute(
+    ctx.client.set_input_mute(
         name=input_name,
         muted=new_state,
     )

obsws_cli/profile.py

@@ -2,36 +2,45 @@
 
 from typing import Annotated
 
-import typer
+from cyclopts import App, Parameter
 from rich.table import Table
 from rich.text import Text
 
 from . import console, util, validate
-from .alias import SubTyperAliasGroup
+from .context import Context
+from .enum import ExitCode
+from .error import OBSWSCLIError
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(name='profile', help='Commands for managing profiles in OBS')
 
 
-@app.callback()
+@app.command(name=['list', 'ls'])
-def main():
+def list_(
-    """Control profiles in OBS."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """List profiles.
 
+    Parameters
+    ----------
+    ctx: Context
+        The context containing the client and style.
 
-@app.command('list | ls')
+    """
-def list_(ctx: typer.Context):
+    resp = ctx.client.get_profile_list()
-    """List profiles."""
-    resp = ctx.obj['obsws'].get_profile_list()
 
-    table = Table(
+    table = Table(title='Profiles', padding=(0, 2), border_style=ctx.style.border)
-        title='Profiles', padding=(0, 2), border_style=ctx.obj['style'].border
-    )
     columns = [
-        (Text('Profile Name', justify='center'), 'left', ctx.obj['style'].column),
+        (Text('Profile Name', justify='center'), 'left', ctx.style.column),
         (Text('Current', justify='center'), 'center', None),
     ]
     for heading, justify, style in columns:
         table.add_column(heading, justify=justify, style=style)
 
+    if not resp.profiles:
+        console.out.print('No profiles found.')
+        return
+
     for profile in resp.profiles:
         table.add_row(
             profile,
@@ -43,70 +52,110 @@ def list_(ctx: typer.Context):
     console.out.print(table)
 
 
-@app.command('current | get')
+@app.command(name=['current', 'get'])
-def current(ctx: typer.Context):
+def current(
-    """Get the current profile."""
+    *,
-    resp = ctx.obj['obsws'].get_profile_list()
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get the current profile.
+
+    Parameters
+    ----------
+    ctx: Context
+        The context containing the client and style.
+
+    """
+    resp = ctx.client.get_profile_list()
     console.out.print(
         f'Current profile: {console.highlight(ctx, resp.current_profile_name)}'
     )
 
 
-@app.command('switch | set')
+@app.command(name=['switch', 'set'])
 def switch(
-    ctx: typer.Context,
+    profile_name: str,
-    profile_name: Annotated[
+    /,
-        str,
+    *,
-        typer.Argument(
+    ctx: Annotated[Context, Parameter(parse=False)],
-            ..., show_default=False, help='Name of the profile to switch to'
-        ),
-    ],
 ):
-    """Switch to a profile."""
+    """Switch to a profile.
+
+    Parameters
+    ----------
+    profile_name: str
+        Name of the profile to switch to.
+    ctx: Context
+        The context containing the client and style.
+
+    """
     if not validate.profile_exists(ctx, profile_name):
         console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
-        raise typer.Exit(1)
+        raise OBSWSCLIError(
-
+            f'Profile [yellow]{profile_name}[/yellow] not found.',
-    resp = ctx.obj['obsws'].get_profile_list()
+            code=ExitCode.ERROR,
-    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)
+    resp = ctx.client.get_profile_list()
+    if resp.current_profile_name == profile_name:
+        raise OBSWSCLIError(
+            f'Profile [yellow]{profile_name}[/yellow] is already the current profile.',
+            code=ExitCode.ERROR,
+        )
+
+    ctx.client.set_current_profile(profile_name)
     console.out.print(f'Switched to profile {console.highlight(ctx, profile_name)}.')
 
 
-@app.command('create | new')
+@app.command(name=['create', 'new'])
 def create(
-    ctx: typer.Context,
+    profile_name: str,
-    profile_name: Annotated[
+    /,
-        str,
+    *,
-        typer.Argument(..., show_default=False, help='Name of the profile to create.'),
+    ctx: Annotated[Context, Parameter(parse=False)],
-    ],
 ):
-    """Create a new profile."""
+    """Create a new profile.
-    if validate.profile_exists(ctx, profile_name):
-        console.err.print(f'Profile [yellow]{profile_name}[/yellow] already exists.')
-        raise typer.Exit(1)
 
-    ctx.obj['obsws'].create_profile(profile_name)
+    Parameters
+    ----------
+    profile_name: str
+        Name of the profile to create.
+    ctx: Context
+        The context containing the client and style.
+
+    """
+    if validate.profile_exists(ctx, profile_name):
+        raise OBSWSCLIError(
+            f'Profile [yellow]{profile_name}[/yellow] already exists.',
+            code=ExitCode.ERROR,
+        )
+
+    ctx.client.create_profile(profile_name)
     console.out.print(f'Created profile {console.highlight(ctx, profile_name)}.')
 
 
-@app.command('remove | rm')
+@app.command(name=['remove', 'rm'])
 def remove(
-    ctx: typer.Context,
+    profile_name: str,
-    profile_name: Annotated[
+    /,
-        str,
+    *,
-        typer.Argument(..., show_default=False, help='Name of the profile to remove.'),
+    ctx: Annotated[Context, Parameter(parse=False)],
-    ],
 ):
-    """Remove a profile."""
+    """Remove a profile.
+
+    Parameters
+    ----------
+    profile_name: str
+        Name of the profile to remove.
+    ctx: Context
+        The context containing the client and style.
+
+    """
     if not validate.profile_exists(ctx, profile_name):
         console.err.print(f'Profile [yellow]{profile_name}[/yellow] not found.')
-        raise typer.Exit(1)
+        raise OBSWSCLIError(
+            f'Profile [yellow]{profile_name}[/yellow] not found.',
+            code=ExitCode.ERROR,
+        )
 
-    ctx.obj['obsws'].remove_profile(profile_name)
+    ctx.client.remove_profile(profile_name)
     console.out.print(f'Removed profile {console.highlight(ctx, profile_name)}.')

obsws_cli/projector.py

@@ -1,26 +1,33 @@
 """module containing commands for manipulating projectors in OBS."""
 
-from typing import Annotated
+from typing import Annotated, Optional
 
-import typer
+from cyclopts import App, Parameter, validators
 from rich.table import Table
 from rich.text import Text
 
 from . import console
-from .alias import SubTyperAliasGroup
+from .context import Context
+from .enum import ExitCode
+from .error import OBSWSCLIError
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(name='projector', help='Commands for managing projectors in OBS')
 
 
-@app.callback()
+@app.command(name=['list-monitors', 'ls-m'])
-def main():
+def list_monitors(
-    """Control projectors in OBS."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """List available monitors.
 
+    Parameters
+    ----------
+    ctx : Context
+        The context containing the OBS client and configuration.
 
-@app.command('list-monitors | ls-m')
+    """
-def list_monitors(ctx: typer.Context):
+    resp = ctx.client.get_monitor_list()
-    """List available monitors."""
-    resp = ctx.obj['obsws'].get_monitor_list()
 
     if not resp.monitors:
         console.out.print('No monitors found.')
@@ -31,16 +38,20 @@ def list_monitors(ctx: typer.Context):
         key=lambda m: m[0],
     )
 
+    if not monitors:
+        console.out.print('No monitors available.')
+        return
+
     table = Table(
         title='Available Monitors',
         padding=(0, 2),
-        border_style=ctx.obj['style'].border,
+        border_style=ctx.style.border,
     )
     table.add_column(
-        Text('Index', justify='center'), justify='center', style=ctx.obj['style'].column
+        Text('Index', justify='center'), justify='center', style=ctx.style.column
     )
     table.add_column(
-        Text('Name', justify='center'), justify='left', style=ctx.obj['style'].column
+        Text('Name', justify='center'), justify='left', style=ctx.style.column
     )
 
     for index, monitor in monitors:
@@ -49,29 +60,33 @@ def list_monitors(ctx: typer.Context):
     console.out.print(table)
 
 
-@app.command('open | o')
+@app.command(name=['open', 'o'])
 def open(
-    ctx: typer.Context,
+    source_name: Optional[str] = None,
-    monitor_index: Annotated[
+    /,
-        int,
+    monitor_index: Annotated[int, Parameter(validator=validators.Number(gte=0))] = 0,
-        typer.Option(help='Index of the monitor to open the projector on.'),
+    *,
-    ] = 0,
+    ctx: Annotated[Context, Parameter(parse=False)],
-    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."""
+    """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
+    Parameters
+    ----------
+    source_name : str, optional
+        The name of the source to project. If not provided, the current program scene will be used.
+    monitor_index : int, optional
+        The index of the monitor to open the projector on. Defaults to 0 (the primary monitor).
+    ctx : Context
+        The context containing the OBS client and configuration.
+
+    """
+    if not source_name:
+        source_name = ctx.client.get_current_program_scene().scene_name
+
+    monitors = ctx.client.get_monitor_list().monitors
     for monitor in monitors:
         if monitor['monitorIndex'] == monitor_index:
-            ctx.obj['obsws'].open_source_projector(
+            ctx.client.open_source_projector(
                 source_name=source_name,
                 monitor_index=monitor_index,
             )
@@ -82,8 +97,8 @@ def open(
 
             break
     else:
-        console.err.print(
+        raise OBSWSCLIError(
             f'Monitor with index [yellow]{monitor_index}[/yellow] not found. '
-            f'Use [yellow]obsws-cli projector ls-m[/yellow] to see available monitors.'
+            f'Use [yellow]obsws-cli projector ls-m[/yellow] to see available monitors.',
+            ExitCode.ERROR,
         )
-        raise typer.Exit(code=1)

obsws_cli/record.py

@@ -3,68 +3,104 @@
 from pathlib import Path
 from typing import Annotated, Optional
 
-import typer
+from cyclopts import App, Parameter
 
 from . import console
-from .alias import SubTyperAliasGroup
+from .context import Context
+from .enum import ExitCode
+from .error import OBSWSCLIError
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(name='record', help='Commands for controlling OBS recording functionality.')
 
 
-@app.callback()
+def _get_recording_status(ctx: Context) -> tuple:
-def main():
-    """Control OBS recording functionality."""
-
-
-def _get_recording_status(ctx: typer.Context) -> tuple:
     """Get recording status."""
-    resp = ctx.obj['obsws'].get_record_status()
+    resp = ctx.client.get_record_status()
     return resp.output_active, resp.output_paused
 
 
-@app.command('start | s')
+@app.command(name=['start', 's'])
-def start(ctx: typer.Context):
+def start(
-    """Start recording."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Start recording.
+
+    Parameters
+    ----------
+    ctx: Context
+        The context containing the OBS client and other settings.
+
+    """
     active, paused = _get_recording_status(ctx)
     if active:
         err_msg = 'Recording is already in progress, cannot start.'
         if paused:
             err_msg += ' Try resuming it.'
+        raise OBSWSCLIError(err_msg, ExitCode.ERROR)
 
-        console.err.print(err_msg)
+    ctx.client.start_record()
-        raise typer.Exit(1)
-
-    ctx.obj['obsws'].start_record()
     console.out.print('Recording started successfully.')
 
 
-@app.command('stop | st')
+@app.command(name=['stop', 'st'])
-def stop(ctx: typer.Context):
+def stop(
-    """Stop recording."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Stop recording.
+
+    Parameters
+    ----------
+    ctx: Context
+        The context containing the OBS client and other settings.
+
+    """
     active, _ = _get_recording_status(ctx)
     if not active:
-        console.err.print('Recording is not in progress, cannot stop.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            'Recording is not in progress, cannot stop.', ExitCode.ERROR
+        )
 
-    resp = ctx.obj['obsws'].stop_record()
+    resp = ctx.client.stop_record()
     console.out.print(
         f'Recording stopped successfully. Saved to: {console.highlight(ctx, resp.output_path)}'
     )
 
 
-@app.command('toggle | tg')
+@app.command(name=['toggle', 'tg'])
-def toggle(ctx: typer.Context):
+def toggle(
-    """Toggle recording."""
+    *,
-    resp = ctx.obj['obsws'].toggle_record()
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Toggle recording.
+
+    Parameters
+    ----------
+    ctx: Context
+        The context containing the OBS client and other settings.
+
+    """
+    resp = ctx.client.toggle_record()
     if resp.output_active:
         console.out.print('Recording started successfully.')
     else:
         console.out.print('Recording stopped successfully.')
 
 
-@app.command('status | ss')
+@app.command(name=['status', 'ss'])
-def status(ctx: typer.Context):
+def status(
-    """Get recording status."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get recording status.
+
+    Parameters
+    ----------
+    ctx: Context
+        The context containing the OBS client and other settings.
+
+    """
     active, paused = _get_recording_status(ctx)
     if active:
         if paused:
@@ -75,98 +111,143 @@ def status(ctx: typer.Context):
         console.out.print('Recording is not in progress.')
 
 
-@app.command('resume | r')
+@app.command(name=['resume', 'r'])
-def resume(ctx: typer.Context):
+def resume(
-    """Resume recording."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Resume recording.
+
+    Parameters
+    ----------
+    ctx: Context
+        The context containing the OBS client and other settings.
+
+    """
     active, paused = _get_recording_status(ctx)
     if not active:
-        console.err.print('Recording is not in progress, cannot resume.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            'Recording is not in progress, cannot resume.', ExitCode.ERROR
+        )
     if not paused:
-        console.err.print('Recording is in progress but not paused, cannot resume.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            'Recording is in progress but not paused, cannot resume.', ExitCode.ERROR
+        )
 
-    ctx.obj['obsws'].resume_record()
+    ctx.client.resume_record()
     console.out.print('Recording resumed successfully.')
 
 
-@app.command('pause | p')
+@app.command(name=['pause', 'p'])
-def pause(ctx: typer.Context):
+def pause(
-    """Pause recording."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Pause recording.
+
+    Parameters
+    ----------
+    ctx: Context
+        The context containing the OBS client and other settings.
+
+    """
     active, paused = _get_recording_status(ctx)
     if not active:
-        console.err.print('Recording is not in progress, cannot pause.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            'Recording is not in progress, cannot pause.', ExitCode.ERROR
+        )
     if paused:
-        console.err.print('Recording is in progress but already paused, cannot pause.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            'Recording is in progress but already paused, cannot pause.', ExitCode.ERROR
+        )
 
-    ctx.obj['obsws'].pause_record()
+    ctx.client.pause_record()
     console.out.print('Recording paused successfully.')
 
 
-@app.command('directory | d')
+@app.command(name=['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(
+    record_directory: Optional[Path] = None,
-            file_okay=False,
+    *,
-            dir_okay=True,
+    ctx: Annotated[Context, Parameter(parse=False)],
-            help='Directory to set for recording.',
-        ),
-    ] = None,
 ):
-    """Get or set the recording directory."""
+    """Get or set the recording directory.
+
+    Parameters
+    ----------
+    record_directory: Optional[Path]
+        The directory to set for recording. If not provided, the current recording directory is displayed.
+    ctx: Context
+        The context containing the OBS client and other settings.
+
+    """
     if record_directory is not None:
-        ctx.obj['obsws'].set_record_directory(str(record_directory))
+        ctx.client.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()
+        resp = ctx.client.get_record_directory()
         console.out.print(
             f'Recording directory: {console.highlight(ctx, resp.record_directory)}'
         )
 
 
-@app.command('split | sp')
+@app.command(name=['split', 'sp'])
-def split(ctx: typer.Context):
+def split(
-    """Split the current recording."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Split the current recording.
+
+    Parameters
+    ----------
+    ctx: Context
+        The context containing the OBS client and other settings.
+
+    """
     active, paused = _get_recording_status(ctx)
     if not active:
         console.err.print('Recording is not in progress, cannot split.')
-        raise typer.Exit(1)
+        raise OBSWSCLIError(
+            'Recording is not in progress, cannot split.', ExitCode.ERROR
+        )
     if paused:
-        console.err.print('Recording is paused, cannot split.')
+        raise OBSWSCLIError('Recording is paused, cannot split.', ExitCode.ERROR)
-        raise typer.Exit(1)
 
-    ctx.obj['obsws'].split_record_file()
+    ctx.client.split_record_file()
     console.out.print('Recording split successfully.')
 
 
-@app.command('chapter | ch')
+@app.command(name=['chapter', 'ch'])
 def chapter(
-    ctx: typer.Context,
+    chapter_name: Optional[str] = None,
-    chapter_name: Annotated[
+    *,
-        Optional[str],
+    ctx: Annotated[Context, Parameter(parse=False)],
-        typer.Argument(
-            help='Name of the chapter to create.',
-        ),
-    ] = None,
 ):
-    """Create a chapter in the current recording."""
+    """Create a chapter in the current recording.
+
+    Parameters
+    ----------
+    chapter_name: Optional[str]
+        The name of the chapter to create. If not provided, an unnamed chapter is created.
+    ctx: Context
+        The context containing the OBS client and other settings.
+
+    """
     active, paused = _get_recording_status(ctx)
     if not active:
-        console.err.print('Recording is not in progress, cannot create chapter.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            'Recording is not in progress, cannot create chapter.', ExitCode.ERROR
+        )
     if paused:
-        console.err.print('Recording is paused, cannot create chapter.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            'Recording is paused, cannot create chapter.', ExitCode.ERROR
+        )
 
-    ctx.obj['obsws'].create_record_chapter(chapter_name)
+    ctx.client.create_record_chapter(chapter_name)
     console.out.print(
         f'Chapter {console.highlight(ctx, chapter_name or "unnamed")} created successfully.'
     )

obsws_cli/replaybuffer.py

@@ -1,64 +1,113 @@
 """module containing commands for manipulating the replay buffer in OBS."""
 
-import typer
+from typing import Annotated
+
+from cyclopts import App, Parameter
 
 from . import console
-from .alias import SubTyperAliasGroup
+from .context import Context
+from .enum import ExitCode
+from .error import OBSWSCLIError
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(
+    name='replaybuffer', help='Commands for controlling the replay buffer in OBS.'
+)
 
 
-@app.callback()
+@app.command(name=['start', 's'])
-def main():
+def start(
-    """Control profiles in OBS."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Start the replay buffer.
 
+    Parameters
+    ----------
+    ctx: Context
+        The context containing the OBS client and other settings.
 
-@app.command('start | s')
+    """
-def start(ctx: typer.Context):
+    resp = ctx.client.get_replay_buffer_status()
-    """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 OBSWSCLIError('Replay buffer is already active.', ExitCode.ERROR)
-        raise typer.Exit(1)
 
-    ctx.obj['obsws'].start_replay_buffer()
+    ctx.client.start_replay_buffer()
     console.out.print('Replay buffer started.')
 
 
-@app.command('stop | st')
+@app.command(name=['stop', 'st'])
-def stop(ctx: typer.Context):
+def stop(
-    """Stop the replay buffer."""
+    *,
-    resp = ctx.obj['obsws'].get_replay_buffer_status()
+    ctx: Annotated[Context, Parameter(parse=False)],
-    if not resp.output_active:
+):
-        console.err.print('Replay buffer is not active.')
+    """Stop the replay buffer.
-        raise typer.Exit(1)
 
-    ctx.obj['obsws'].stop_replay_buffer()
+    Parameters
+    ----------
+    ctx: Context
+        The context containing the OBS client and other settings.
+
+    """
+    resp = ctx.client.get_replay_buffer_status()
+    if not resp.output_active:
+        raise OBSWSCLIError('Replay buffer is not active.', ExitCode.ERROR)
+
+    ctx.client.stop_replay_buffer()
     console.out.print('Replay buffer stopped.')
 
 
-@app.command('toggle | tg')
+@app.command(name=['toggle', 'tg'])
-def toggle(ctx: typer.Context):
+def toggle(
-    """Toggle the replay buffer."""
+    *,
-    resp = ctx.obj['obsws'].toggle_replay_buffer()
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Toggle the replay buffer.
+
+    Parameters
+    ----------
+    ctx: Context
+        The context containing the OBS client and other settings.
+
+    """
+    resp = ctx.client.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 | ss')
+@app.command(name=['status', 'ss'])
-def status(ctx: typer.Context):
+def status(
-    """Get the status of the replay buffer."""
+    *,
-    resp = ctx.obj['obsws'].get_replay_buffer_status()
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get the status of the replay buffer.
+
+    Parameters
+    ----------
+    ctx: Context
+        The context containing the OBS client and other settings.
+
+    """
+    resp = ctx.client.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 | sv')
+@app.command(name=['save', 'sv'])
-def save(ctx: typer.Context):
+def save(
-    """Save the replay buffer."""
+    *,
-    ctx.obj['obsws'].save_replay_buffer()
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Save the replay buffer.
+
+    Parameters
+    ----------
+    ctx: Context
+        The context containing the OBS client and other settings.
+
+    """
+    ctx.client.save_replay_buffer()
     console.out.print('Replay buffer saved.')

obsws_cli/scene.py

@@ -2,45 +2,56 @@
 
 from typing import Annotated
 
-import typer
+from cyclopts import App, Parameter
 from rich.table import Table
 from rich.text import Text
 
 from . import console, util, validate
-from .alias import SubTyperAliasGroup
+from .context import Context
+from .enum import ExitCode
+from .error import OBSWSCLIError
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(name='scene', help='Commands for managing OBS scenes')
 
 
-@app.callback()
+@app.command(name=['list', 'ls'])
-def main():
-    """Control OBS scenes."""
-
-
-@app.command('list | ls')
 def list_(
-    ctx: typer.Context,
+    uuid: bool = False,
-    uuid: Annotated[bool, typer.Option(help='Show UUIDs of scenes')] = False,
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
 ):
-    """List all scenes."""
+    """List all scenes.
-    resp = ctx.obj['obsws'].get_scene_list()
+
+    Parameters
+    ----------
+    uuid : bool
+        Show UUIDs of scenes.
+    ctx : Context
+        The context containing the OBS client and configuration.
+
+    """
+    resp = ctx.client.get_scene_list()
     scenes = (
         (scene.get('sceneName'), scene.get('sceneUuid'))
         for scene in reversed(resp.scenes)
     )
 
-    active_scene = ctx.obj['obsws'].get_current_program_scene().scene_name
+    if not scenes:
+        console.out.print('No scenes found.')
+        return
 
-    table = Table(title='Scenes', padding=(0, 2), border_style=ctx.obj['style'].border)
+    active_scene = ctx.client.get_current_program_scene().scene_name
+
+    table = Table(title='Scenes', padding=(0, 2), border_style=ctx.style.border)
     if uuid:
         columns = [
-            (Text('Scene Name', justify='center'), 'left', ctx.obj['style'].column),
+            (Text('Scene Name', justify='center'), 'left', ctx.style.column),
             (Text('Active', justify='center'), 'center', None),
-            (Text('UUID', justify='center'), 'left', ctx.obj['style'].column),
+            (Text('UUID', justify='center'), 'left', ctx.style.column),
         ]
     else:
         columns = [
-            (Text('Scene Name', justify='center'), 'left', ctx.obj['style'].column),
+            (Text('Scene Name', justify='center'), 'left', ctx.style.column),
             (Text('Active', justify='center'), 'center', None),
         ]
     for heading, justify, style in columns:
@@ -62,57 +73,79 @@ def list_(
     console.out.print(table)
 
 
-@app.command('current | get')
+@app.command(name=['current', 'get'])
 def current(
-    ctx: typer.Context,
+    preview: bool = False,
-    preview: Annotated[
+    *,
-        bool, typer.Option(help='Get the preview scene instead of the program scene')
+    ctx: Annotated[Context, Parameter(parse=False)],
-    ] = False,
 ):
-    """Get the current program scene or preview scene."""
+    """Get the current program scene or preview scene.
+
+    Parameters
+    ----------
+    preview : bool
+        If True, get the preview scene instead of the program scene.
+    ctx : Context
+        The context containing the OBS client and configuration.
+
+    """
     if preview and not validate.studio_mode_enabled(ctx):
-        console.err.print('Studio mode is not enabled, cannot get preview scene.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            'Studio mode is not enabled, cannot get preview scene.',
+            code=ExitCode.ERROR,
+        )
 
     if preview:
-        resp = ctx.obj['obsws'].get_current_preview_scene()
+        resp = ctx.client.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()
+        resp = ctx.client.get_current_program_scene()
         console.out.print(
             f'Current Program Scene: {console.highlight(ctx, resp.current_program_scene_name)}'
         )
 
 
-@app.command('switch | set')
+@app.command(name=['switch', 'set'])
 def switch(
-    ctx: typer.Context,
+    scene_name: str,
-    scene_name: Annotated[
+    /,
-        str, typer.Argument(..., help='Name of the scene to switch to')
+    preview: bool = False,
-    ],
+    *,
-    preview: Annotated[
+    ctx: Annotated[Context, Parameter(parse=False)],
-        bool,
-        typer.Option(help='Switch to the preview scene instead of the program scene'),
-    ] = False,
 ):
-    """Switch to a scene."""
+    """Switch to a scene.
+
+    Parameters
+    ----------
+    scene_name : str
+        The name of the scene to switch to.
+    preview : bool
+        If True, switch to the preview scene instead of the program scene.
+    ctx : Context
+        The context containing the OBS client and configuration.
+
+    """
     if preview and not validate.studio_mode_enabled(ctx):
-        console.err.print('Studio mode is not enabled, cannot set the preview scene.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            'Studio mode is not enabled, cannot switch to preview scene.',
+            code=ExitCode.ERROR,
+        )
 
     if not validate.scene_in_scenes(ctx, scene_name):
-        console.err.print(f'Scene [yellow]{scene_name}[/yellow] not found.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            f'Scene [yellow]{scene_name}[/yellow] not found.',
+            code=ExitCode.ERROR,
+        )
 
     if preview:
-        ctx.obj['obsws'].set_current_preview_scene(scene_name)
+        ctx.client.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)
+        ctx.client.set_current_program_scene(scene_name)
         console.out.print(
             f'Switched to program scene: {console.highlight(ctx, scene_name)}'
         )

obsws_cli/scenecollection.py

@@ -2,33 +2,44 @@
 
 from typing import Annotated
 
-import typer
+from cyclopts import App, Parameter
 from rich.table import Table
 
 from . import console, validate
-from .alias import SubTyperAliasGroup
+from .context import Context
+from .enum import ExitCode
+from .error import OBSWSCLIError
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(
+    name='scenecollection', help='Commands for controlling scene collections in OBS.'
+)
 
 
-@app.callback()
+@app.command(name=['list', 'ls'])
-def main():
+def list_(
-    """Control scene collections in OBS."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """List all scene collections.
 
+    Parameters
+    ----------
+    ctx : Context
+        The context containing the OBS client and configuration.
 
-@app.command('list | ls')
+    """
-def list_(ctx: typer.Context):
+    resp = ctx.client.get_scene_collection_list()
-    """List all scene collections."""
-    resp = ctx.obj['obsws'].get_scene_collection_list()
 
     table = Table(
         title='Scene Collections',
         padding=(0, 2),
-        border_style=ctx.obj['style'].border,
+        border_style=ctx.style.border,
-    )
-    table.add_column(
-        'Scene Collection Name', justify='left', style=ctx.obj['style'].column
     )
+    table.add_column('Scene Collection Name', justify='left', style=ctx.style.column)
+
+    if not resp.scene_collections:
+        console.out.print('No scene collections found.')
+        return
 
     for scene_collection_name in resp.scene_collections:
         table.add_row(scene_collection_name)
@@ -36,59 +47,87 @@ def list_(ctx: typer.Context):
     console.out.print(table)
 
 
-@app.command('current | get')
+@app.command(name=['current', 'get'])
-def current(ctx: typer.Context):
+def current(
-    """Get the current scene collection."""
+    *,
-    resp = ctx.obj['obsws'].get_scene_collection_list()
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get the current scene collection.
+
+    Parameters
+    ----------
+    ctx : Context
+        The context containing the OBS client and configuration.
+
+    """
+    resp = ctx.client.get_scene_collection_list()
     console.out.print(
         f'Current scene collection: {console.highlight(ctx, resp.current_scene_collection_name)}'
     )
 
 
-@app.command('switch | set')
+@app.command(name=['switch', 'set'])
 def switch(
-    ctx: typer.Context,
+    scene_collection_name: str,
-    scene_collection_name: Annotated[
+    /,
-        str, typer.Argument(..., help='Name of the scene collection to switch to')
+    *,
-    ],
+    ctx: Annotated[Context, Parameter(parse=False)],
 ):
-    """Switch to a scene collection."""
+    """Switch to a scene collection.
+
+    Parameters
+    ----------
+    scene_collection_name : str
+        The name of the scene collection to switch to.
+    ctx : Context
+        The context containing the OBS client and configuration.
+
+    """
     if not validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
-        console.err.print(
+        raise OBSWSCLIError(
-            f'Scene collection [yellow]{scene_collection_name}[/yellow] not found.'
+            f'Scene collection [yellow]{scene_collection_name}[/yellow] not found.',
+            exit_code=ExitCode.ERROR,
         )
-        raise typer.Exit(1)
 
     current_scene_collection = (
-        ctx.obj['obsws'].get_scene_collection_list().current_scene_collection_name
+        ctx.client.get_scene_collection_list().current_scene_collection_name
     )
     if scene_collection_name == current_scene_collection:
-        console.err.print(
+        raise OBSWSCLIError(
-            f'Scene collection [yellow]{scene_collection_name}[/yellow] is already active.'
+            f'Scene collection [yellow]{scene_collection_name}[/yellow] is already active.',
+            exit_code=ExitCode.ERROR,
         )
-        raise typer.Exit(1)
 
-    ctx.obj['obsws'].set_current_scene_collection(scene_collection_name)
+    ctx.client.set_current_scene_collection(scene_collection_name)
     console.out.print(
         f'Switched to scene collection {console.highlight(ctx, scene_collection_name)}.'
     )
 
 
-@app.command('create | new')
+@app.command(name=['create', 'new'])
 def create(
-    ctx: typer.Context,
+    scene_collection_name: str,
-    scene_collection_name: Annotated[
+    /,
-        str, typer.Argument(..., help='Name of the scene collection to create')
+    *,
-    ],
+    ctx: Annotated[Context, Parameter(parse=False)],
 ):
-    """Create a new scene collection."""
+    """Create a new scene collection.
-    if validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
-        console.err.print(
-            f'Scene collection [yellow]{scene_collection_name}[/yellow] already exists.'
-        )
-        raise typer.Exit(1)
 
-    ctx.obj['obsws'].create_scene_collection(scene_collection_name)
+    Parameters
+    ----------
+    scene_collection_name : str
+        The name of the scene collection to create.
+    ctx : Context
+        The context containing the OBS client and configuration.
+
+    """
+    if validate.scene_collection_in_scene_collections(ctx, scene_collection_name):
+        raise OBSWSCLIError(
+            f'Scene collection [yellow]{scene_collection_name}[/yellow] already exists.',
+            exit_code=ExitCode.ERROR,
+        )
+
+    ctx.client.create_scene_collection(scene_collection_name)
     console.out.print(
         f'Created scene collection {console.highlight(ctx, scene_collection_name)}.'
     )

obsws_cli/sceneitem.py

@@ -2,41 +2,49 @@
 
 from typing import Annotated, Optional
 
-import typer
+from cyclopts import App, Parameter
 from rich.table import Table
 
 from . import console, util, validate
-from .alias import SubTyperAliasGroup
+from .context import Context
+from .enum import ExitCode
+from .error import OBSWSCLIError
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(name='sceneitem', help='Commands for controlling scene items in OBS.')
 
 
-@app.callback()
+@app.command(name=['list', 'ls'])
-def main():
-    """Control items in OBS scenes."""
-
-
-@app.command('list | ls')
 def list_(
-    ctx: typer.Context,
+    scene_name: Optional[str] = None,
-    scene_name: Annotated[
+    /,
-        Optional[str],
+    uuid: bool = False,
-        typer.Argument(
+    *,
-            show_default='The current scene',
+    ctx: Annotated[Context, Parameter(parse=False)],
-            help='Scene name to list items for',
-        ),
-    ] = None,
-    uuid: Annotated[bool, typer.Option(help='Show UUIDs of scene items')] = False,
 ):
-    """List all items in a scene."""
+    """List all items in a scene.
+
+    Parameters
+    ----------
+    scene_name : str, optional
+        The name of the scene to list items for. If not provided, the current program scene
+        will be used.
+    uuid : bool
+        Show UUIDs of scene items.
+    ctx : Context
+        The context containing the OBS client and configuration.
+
+    """
     if not scene_name:
-        scene_name = ctx.obj['obsws'].get_current_program_scene().scene_name
+        scene_name = ctx.client.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)
+        raise OBSWSCLIError(
+            f'Scene [yellow]{scene_name}[/yellow] not found.',
+            exit_code=ExitCode.ERROR,
+        )
 
-    resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
+    resp = ctx.client.get_scene_item_list(scene_name)
     items = sorted(
         (
             (
@@ -55,26 +63,26 @@ def list_(
         console.out.print(
             f'No items found in scene {console.highlight(ctx, scene_name)}.'
         )
-        raise typer.Exit()
+        return
 
     table = Table(
         title=f'Items in Scene: {scene_name}',
         padding=(0, 2),
-        border_style=ctx.obj['style'].border,
+        border_style=ctx.style.border,
     )
     if uuid:
         columns = [
-            ('Item ID', 'center', ctx.obj['style'].column),
+            ('Item ID', 'center', ctx.style.column),
-            ('Item Name', 'left', ctx.obj['style'].column),
+            ('Item Name', 'left', ctx.style.column),
-            ('In Group', 'left', ctx.obj['style'].column),
+            ('In Group', 'left', ctx.style.column),
             ('Enabled', 'center', None),
-            ('UUID', 'left', ctx.obj['style'].column),
+            ('UUID', 'left', ctx.style.column),
         ]
     else:
         columns = [
-            ('Item ID', 'center', ctx.obj['style'].column),
+            ('Item ID', 'center', ctx.style.column),
-            ('Item Name', 'left', ctx.obj['style'].column),
+            ('Item Name', 'left', ctx.style.column),
-            ('In Group', 'left', ctx.obj['style'].column),
+            ('In Group', 'left', ctx.style.column),
             ('Enabled', 'center', None),
         ]
     # Add columns to the table
@@ -83,7 +91,7 @@ def list_(
 
     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)
+            resp = ctx.client.get_group_scene_item_list(item_name)
             group_items = sorted(
                 (
                     (
@@ -138,79 +146,91 @@ def list_(
 
 
 def _validate_sources(
-    ctx: typer.Context,
+    ctx: 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.')
+        raise OBSWSCLIError(
-        return False
+            f'Scene [yellow]{scene_name}[/yellow] not found.',
+            exit_code=ExitCode.ERROR,
+        )
 
     if group:
         if not validate.item_in_scene_item_list(ctx, scene_name, group):
-            console.err.print(
+            raise OBSWSCLIError(
-                f'Group [yellow]{group}[/yellow] not found in scene [yellow]{scene_name}[/yellow].'
+                f'Group [yellow]{group}[/yellow] not found in scene [yellow]{scene_name}[/yellow].',
+                exit_code=ExitCode.ERROR,
             )
-            return False
     else:
         if not validate.item_in_scene_item_list(ctx, scene_name, item_name):
-            console.err.print(
+            raise OBSWSCLIError(
                 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.'
+                'Use [yellow]obsws-cli sceneitem ls[/yellow] for a list of items in the scene.',
+                exit_code=ExitCode.ERROR,
             )
-            return False
-
-    return True
 
 
 def _get_scene_name_and_item_id(
-    ctx: typer.Context, scene_name: str, item_name: str, group: Optional[str] = None
+    ctx: 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)
+        resp = ctx.client.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(
+            raise OBSWSCLIError(
-                f'Item [yellow]{item_name}[/yellow] not found in group [yellow]{group}[/yellow].'
+                f'Item [yellow]{item_name}[/yellow] not found in group [yellow]{group}[/yellow].',
+                exit_code=ExitCode.ERROR,
             )
-            raise typer.Exit(1)
     else:
-        resp = ctx.obj['obsws'].get_scene_item_id(scene_name, item_name)
+        resp = ctx.client.get_scene_item_id(scene_name, item_name)
         scene_item_id = resp.scene_item_id
 
     return scene_name, scene_item_id
 
 
-@app.command('show | sh')
+@app.command(name=['show', 'sh'])
 def show(
-    ctx: typer.Context,
+    scene_name: str,
-    scene_name: Annotated[
+    item_name: str,
-        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
+    /,
-    ],
+    group: Optional[str] = None,
-    item_name: Annotated[
+    *,
-        str,
+    ctx: Annotated[Context, Parameter(parse=False)],
-        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."""
+    """Show an item in a scene.
-    if not _validate_sources(ctx, scene_name, item_name, group):
+
-        raise typer.Exit(1)
+    Parameters
+    ----------
+    scene_name : str
+        The name of the scene the item is in.
+    item_name : str
+        The name of the item to show in the scene.
+    group : str, optional
+        The name of the parent group the item is in, if applicable.
+    ctx : Context
+        The context containing the OBS client and configuration.
+
+    """
+    _validate_sources(ctx, scene_name, item_name, group)
 
     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(
+    ctx.client.set_scene_item_enabled(
         scene_name=scene_name,
         item_id=int(scene_item_id),
         enabled=True,
@@ -231,28 +251,37 @@ def show(
         )
 
 
-@app.command('hide | h')
+@app.command(name=['hide', 'h'])
 def hide(
-    ctx: typer.Context,
+    scene_name: str,
-    scene_name: Annotated[
+    item_name: str,
-        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
+    /,
-    ],
+    group: Optional[str] = None,
-    item_name: Annotated[
+    *,
-        str,
+    ctx: Annotated[Context, Parameter(parse=False)],
-        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."""
+    """Hide an item in a scene.
-    if not _validate_sources(ctx, scene_name, item_name, group):
+
-        raise typer.Exit(1)
+    Parameters
+    ----------
+    scene_name : str
+        The name of the scene the item is in.
+    item_name : str
+        The name of the item to hide in the scene.
+    group : str, optional
+        The name of the parent group the item is in, if applicable.
+    ctx : Context
+        The context containing the OBS client and configuration.
+
+    """
+    _validate_sources(ctx, scene_name, item_name, group)
 
     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(
+    ctx.client.set_scene_item_enabled(
         scene_name=scene_name,
         item_id=int(scene_item_id),
         enabled=False,
@@ -272,36 +301,43 @@ def hide(
         )
 
 
-@app.command('toggle | tg')
+@app.command(name=['toggle', 'tg'])
 def toggle(
-    ctx: typer.Context,
+    scene_name: str,
-    scene_name: Annotated[
+    item_name: str,
-        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
+    /,
-    ],
+    group: Optional[str] = None,
-    item_name: Annotated[
+    *,
-        str,
+    ctx: Annotated[Context, Parameter(parse=False)],
-        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."""
+    """Toggle an item in a scene.
-    if not _validate_sources(ctx, scene_name, item_name, group):
+
-        raise typer.Exit(1)
+    Parameters
+    ----------
+    scene_name : str
+        The name of the scene the item is in.
+    item_name : str
+        The name of the item to toggle in the scene.
+    group : str, optional
+        The name of the parent group the item is in, if applicable.
+    ctx : Context
+        The context containing the OBS client and configuration.
+
+    """
+    _validate_sources(ctx, scene_name, item_name, group)
 
     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(
+    enabled = ctx.client.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(
+    ctx.client.set_scene_item_enabled(
         scene_name=scene_name,
         item_id=int(scene_item_id),
         enabled=new_state,
@@ -333,30 +369,37 @@ def toggle(
             )
 
 
-@app.command('visible | v')
+@app.command(name=['visible', 'v'])
 def visible(
-    ctx: typer.Context,
+    scene_name: str,
-    scene_name: Annotated[
+    item_name: str,
-        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
+    /,
-    ],
+    group: Optional[str] = None,
-    item_name: Annotated[
+    *,
-        str,
+    ctx: Annotated[Context, Parameter(parse=False)],
-        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."""
+    """Check if an item in a scene is visible.
-    if not _validate_sources(ctx, scene_name, item_name, group):
+
-        raise typer.Exit(1)
+    Parameters
+    ----------
+    scene_name : str
+        The name of the scene the item is in.
+    item_name : str
+        The name of the item to check visibility in the scene.
+    group : str, optional
+        The name of the parent group the item is in, if applicable.
+    ctx : Context
+        The context containing the OBS client and configuration.
+
+    """
+    _validate_sources(ctx, scene_name, item_name, group)
 
     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(
+    enabled = ctx.client.get_scene_item_enabled(
         scene_name=scene_name,
         item_id=int(scene_item_id),
     )
@@ -377,68 +420,75 @@ def visible(
         )
 
 
-@app.command('transform | t')
+@app.command(name=['transform', 't'])
 def transform(
-    ctx: typer.Context,
+    scene_name: str,
-    scene_name: Annotated[
+    item_name: str,
-        str, typer.Argument(..., show_default=False, help='Scene name the item is in')
+    /,
-    ],
+    group: Optional[str] = None,
-    item_name: Annotated[
+    alignment: Optional[int] = None,
-        str,
+    bounds_alignment: Optional[int] = None,
-        typer.Argument(
+    bounds_height: Optional[float] = None,
-            ..., show_default=False, help='Item name to transform in the scene'
+    bounds_type: Optional[str] = None,
-        ),
+    bounds_width: Optional[float] = None,
-    ],
+    crop_to_bounds: Optional[bool] = None,
-    group: Annotated[Optional[str], typer.Option(help='Parent group name')] = None,
+    crop_bottom: Optional[float] = None,
-    alignment: Annotated[
+    crop_left: Optional[float] = None,
-        Optional[int], typer.Option(help='Alignment of the item in the scene')
+    crop_right: Optional[float] = None,
-    ] = None,
+    crop_top: Optional[float] = None,
-    bounds_alignment: Annotated[
+    position_x: Optional[float] = None,
-        Optional[int], typer.Option(help='Bounds alignment of the item in the scene')
+    position_y: Optional[float] = None,
-    ] = None,
+    rotation: Optional[float] = None,
-    bounds_height: Annotated[
+    scale_x: Optional[float] = None,
-        Optional[float], typer.Option(help='Height of the item in the scene')
+    scale_y: Optional[float] = None,
-    ] = None,
+    *,
-    bounds_type: Annotated[
+    ctx: Annotated[Context, Parameter(parse=False)],
-        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."""
+    """Set the transform of an item in a scene.
-    if not _validate_sources(ctx, scene_name, item_name, group):
+
-        raise typer.Exit(1)
+    Parameters
+    ----------
+    scene_name : str
+        The name of the scene the item is in.
+    item_name : str
+        The name of the item to transform in the scene.
+    group : str, optional
+        The name of the parent group the item is in, if applicable.
+    alignment : int, optional
+        Alignment of the item in the scene.
+    bounds_alignment : int, optional
+        Bounds alignment of the item in the scene.
+    bounds_height : float, optional
+        Height of the item in the scene.
+    bounds_type : str, optional
+        Type of bounds for the item in the scene.
+    bounds_width : float, optional
+        Width of the item in the scene.
+    crop_to_bounds : bool, optional
+        Crop the item to the bounds.
+    crop_bottom : float, optional
+        Bottom crop of the item in the scene.
+    crop_left : float, optional
+        Left crop of the item in the scene.
+    crop_right : float, optional
+        Right crop of the item in the scene.
+    crop_top : float, optional
+        Top crop of the item in the scene.
+    position_x : float, optional
+        X position of the item in the scene.
+    position_y : float, optional
+        Y position of the item in the scene.
+    rotation : float, optional
+        Rotation of the item in the scene.
+    scale_x : float, optional
+        X scale of the item in the scene.
+    scale_y : float, optional
+        Y scale of the item in the scene.
+    ctx : Context
+        The context containing the OBS client and configuration.
+
+    """
+    _validate_sources(ctx, scene_name, item_name, group)
 
     old_scene_name = scene_name
     scene_name, scene_item_id = _get_scene_name_and_item_id(
@@ -478,10 +528,12 @@ def transform(
         transform['scaleY'] = scale_y
 
     if not transform:
-        console.err.print('No transform options provided.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            'No transform options provided. Use at least one of the transform options.',
+            exit_code=ExitCode.ERROR,
+        )
 
-    transform = ctx.obj['obsws'].set_scene_item_transform(
+    transform = ctx.client.set_scene_item_transform(
         scene_name=scene_name,
         item_id=int(scene_item_id),
         transform=transform,

obsws_cli/screenshot.py

@@ -4,66 +4,51 @@ from pathlib import Path
 from typing import Annotated
 
 import obsws_python as obsws
-import typer
+from cyclopts import App, Parameter, validators
 
 from . import console
-from .alias import SubTyperAliasGroup
+from .context import Context
+from .enum import ExitCode
+from .error import OBSWSCLIError
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(name='screenshot', help='Commands for taking screenshots using OBS.')
 
 
-@app.callback()
+@app.command(name=['save', 'sv'])
-def main():
-    """Take screenshots using OBS."""
-
-
-@app.command('save | sv')
 def save(
-    ctx: typer.Context,
+    source_name: str,
-    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(
+    output_path: Path,
-            ...,
+    /,
-            show_default=False,
+    width: float = 1920,
-            file_okay=True,
+    height: float = 1080,
-            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,
+        float, Parameter(validator=validators.Number(gte=-1, lte=100))
-        typer.Option(
+    ] = -1.0,
-            min=-1,
+    *,
-            max=100,
+    ctx: Annotated[Context, Parameter(parse=False)],
-            help='Quality of the screenshot.',
-        ),
-    ] = -1,
 ):
-    """Take a screenshot and save it to a file."""
+    """Take a screenshot and save it to a file.
+
+    Parameters
+    ----------
+    source_name : str
+        Name of the source to take a screenshot of.
+    output_path : Path
+        Path to save the screenshot (must include file name and extension).
+    width : float
+        Width of the screenshot.
+    height : float
+        Height of the screenshot.
+    quality : float
+        Quality of the screenshot. A value of -1 uses the default quality.
+    ctx : Context
+        Context containing the OBS WebSocket client instance.
+
+    """
     try:
-        ctx.obj['obsws'].save_source_screenshot(
+        ctx.client.save_source_screenshot(
             name=source_name,
             img_format=output_path.suffix.lstrip('.').lower(),
             file_path=str(output_path),
@@ -74,16 +59,16 @@ def save(
     except obsws.error.OBSSDKRequestError as e:
         match e.code:
             case 403:
-                console.err.print(
+                raise OBSWSCLIError(
                     'The [yellow]image format[/yellow] (file extension) must be included in the file name, '
                     "for example: '/path/to/screenshot.png'.",
+                    code=ExitCode.ERROR,
                 )
-                raise typer.Exit(1)
             case 600:
-                console.err.print(
+                raise OBSWSCLIError(
-                    f'No source was found by the name of [yellow]{source_name}[/yellow]'
+                    'No source was found by the name of [yellow]{source_name}[/yellow]',
+                    code=ExitCode.ERROR,
                 )
-                raise typer.Exit(1)
             case _:
                 raise
 

obsws_cli/settings.py

@@ -1,80 +0,0 @@
-"""module for settings management for obsws-cli."""
-
-from collections import UserDict
-from pathlib import Path
-
-from dotenv import dotenv_values
-
-SettingsValue = str | int
-
-
-class Settings(UserDict):
-    """A class to manage settings for obsws-cli.
-
-    This class extends UserDict to provide a dictionary-like interface for settings.
-    It loads settings from environment variables and .env files.
-    The settings are expected to be in uppercase and should start with 'OBS_'.
-
-    Example:
-    -------
-        settings = Settings()
-        host = settings['OBS_HOST']
-        settings['OBS_PORT'] = 4455
-
-    """
-
-    PREFIX = 'OBS_'
-
-    def __init__(self, *args, **kwargs):
-        """Initialize the Settings object."""
-        kwargs.update(
-            {
-                **dotenv_values('.env'),
-                **dotenv_values(Path.home() / '.config' / 'obsws-cli' / 'obsws.env'),
-            }
-        )
-        super().__init__(*args, **kwargs)
-
-    def __getitem__(self, key: str) -> SettingsValue:
-        """Get a setting value by key."""
-        key = key.upper()
-        if not key.startswith(Settings.PREFIX):
-            key = f'{Settings.PREFIX}{key}'
-        return self.data[key]
-
-    def __setitem__(self, key: str, value: SettingsValue):
-        """Set a setting value by key."""
-        key = key.upper()
-        if not key.startswith(Settings.PREFIX):
-            key = f'{Settings.PREFIX}{key}'
-        self.data[key] = value
-
-
-_settings = Settings(
-    OBS_HOST='localhost',
-    OBS_PORT=4455,
-    OBS_PASSWORD='',
-    OBS_TIMEOUT=5,
-    OBS_DEBUG=False,
-    OBS_STYLE='disabled',
-    OBS_STYLE_NO_BORDER=False,
-)
-
-
-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.
-
-    """
-    return _settings[key]

obsws_cli/stream.py

@@ -1,61 +1,104 @@
 """module for controlling OBS stream functionality."""
 
-import typer
+from typing import Annotated
+
+from cyclopts import App, Parameter
 
 from . import console
-from .alias import SubTyperAliasGroup
+from .context import Context
+from .enum import ExitCode
+from .error import OBSWSCLIError
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(name='stream', help='Commands for controlling OBS stream functionality.')
 
 
-@app.callback()
+def _get_streaming_status(ctx: Context) -> tuple:
-def main():
-    """Control OBS stream functionality."""
-
-
-def _get_streaming_status(ctx: typer.Context) -> tuple:
     """Get streaming status."""
-    resp = ctx.obj['obsws'].get_stream_status()
+    resp = ctx.client.get_stream_status()
     return resp.output_active, resp.output_duration
 
 
-@app.command('start | s')
+@app.command(name=['start', 's'])
-def start(ctx: typer.Context):
+def start(
-    """Start streaming."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Start streaming.
+
+    Parameters
+    ----------
+    ctx : Context
+        Context containing the OBS WebSocket client instance.
+
+    """
     active, _ = _get_streaming_status(ctx)
     if active:
-        console.err.print('Streaming is already in progress, cannot start.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            'Streaming is already in progress, cannot start.',
+            code=ExitCode.ERROR,
+        )
 
-    ctx.obj['obsws'].start_stream()
+    ctx.client.start_stream()
     console.out.print('Streaming started successfully.')
 
 
-@app.command('stop | st')
+@app.command(name=['stop', 'st'])
-def stop(ctx: typer.Context):
+def stop(
-    """Stop streaming."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Stop streaming.
+
+    Parameters
+    ----------
+    ctx : Context
+        Context containing the OBS WebSocket client instance.
+
+    """
     active, _ = _get_streaming_status(ctx)
     if not active:
-        console.err.print('Streaming is not in progress, cannot stop.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            'Streaming is not in progress, cannot stop.',
+            code=ExitCode.ERROR,
+        )
 
-    ctx.obj['obsws'].stop_stream()
+    ctx.client.stop_stream()
     console.out.print('Streaming stopped successfully.')
 
 
-@app.command('toggle | tg')
+@app.command(name=['toggle', 'tg'])
-def toggle(ctx: typer.Context):
+def toggle(
-    """Toggle streaming."""
+    *,
-    resp = ctx.obj['obsws'].toggle_stream()
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Toggle streaming.
+
+    Parameters
+    ----------
+    ctx : Context
+        Context containing the OBS WebSocket client instance.
+
+    """
+    resp = ctx.client.toggle_stream()
     if resp.output_active:
         console.out.print('Streaming started successfully.')
     else:
         console.out.print('Streaming stopped successfully.')
 
 
-@app.command('status | ss')
+@app.command(name=['status', 'ss'])
-def status(ctx: typer.Context):
+def status(
-    """Get streaming status."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get streaming status.
+
+    Parameters
+    ----------
+    ctx : Context
+        Context containing the OBS WebSocket client instance.
+
+    """
     active, duration = _get_streaming_status(ctx)
     if active:
         if duration > 0:

obsws_cli/studiomode.py

@@ -1,48 +1,85 @@
 """module containing commands for manipulating studio mode in OBS."""
 
-import typer
+from typing import Annotated
+
+from cyclopts import App, Parameter
 
 from . import console
-from .alias import SubTyperAliasGroup
+from .context import Context
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(name='studiomode', help='Commands for controlling studio mode in OBS.')
 
 
-@app.callback()
+@app.command(name=['enable', 'on'])
-def main():
+def enable(
-    """Control studio mode in OBS."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Enable studio mode.
 
+    Parameters
+    ----------
+    ctx : Context
+        Context containing the OBS WebSocket client instance.
 
-@app.command('enable | on')
+    """
-def enable(ctx: typer.Context):
+    ctx.client.set_studio_mode_enabled(True)
-    """Enable studio mode."""
-    ctx.obj['obsws'].set_studio_mode_enabled(True)
     console.out.print('Studio mode has been enabled.')
 
 
-@app.command('disable | off')
+@app.command(name=['disable', 'off'])
-def disable(ctx: typer.Context):
+def disable(
-    """Disable studio mode."""
+    *,
-    ctx.obj['obsws'].set_studio_mode_enabled(False)
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Disable studio mode.
+
+    Parameters
+    ----------
+    ctx : Context
+        Context containing the OBS WebSocket client instance.
+
+    """
+    ctx.client.set_studio_mode_enabled(False)
     console.out.print('Studio mode has been disabled.')
 
 
-@app.command('toggle | tg')
+@app.command(name=['toggle', 'tg'])
-def toggle(ctx: typer.Context):
+def toggle(
-    """Toggle studio mode."""
+    *,
-    resp = ctx.obj['obsws'].get_studio_mode_enabled()
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Toggle studio mode.
+
+    Parameters
+    ----------
+    ctx : Context
+        Context containing the OBS WebSocket client instance.
+
+    """
+    resp = ctx.client.get_studio_mode_enabled()
     if resp.studio_mode_enabled:
-        ctx.obj['obsws'].set_studio_mode_enabled(False)
+        ctx.client.set_studio_mode_enabled(False)
         console.out.print('Studio mode is now disabled.')
     else:
-        ctx.obj['obsws'].set_studio_mode_enabled(True)
+        ctx.client.set_studio_mode_enabled(True)
         console.out.print('Studio mode is now enabled.')
 
 
-@app.command('status | ss')
+@app.command(name=['status', 'ss'])
-def status(ctx: typer.Context):
+def status(
-    """Get the status of studio mode."""
+    *,
-    resp = ctx.obj['obsws'].get_studio_mode_enabled()
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get the status of studio mode.
+
+    Parameters
+    ----------
+    ctx : Context
+        Context containing the OBS WebSocket client instance.
+
+    """
+    resp = ctx.client.get_studio_mode_enabled()
     if resp.studio_mode_enabled:
         console.out.print('Studio mode is enabled.')
     else:

obsws_cli/text.py

@@ -2,35 +2,43 @@
 
 from typing import Annotated, Optional
 
-import typer
+from cyclopts import App, Parameter
 
 from . import console, validate
-from .alias import SubTyperAliasGroup
+from .context import Context
+from .enum import ExitCode
+from .error import OBSWSCLIError
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(name='text', help='Commands for controlling text inputs in OBS.')
 
 
-@app.callback()
+@app.command(name=['current', 'get'])
-def main():
-    """Control text inputs in OBS."""
-
-
-@app.command('current | get')
 def current(
-    ctx: typer.Context,
+    input_name: str,
-    input_name: Annotated[str, typer.Argument(help='Name of the text input to get.')],
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
 ):
-    """Get the current text for a text input."""
+    """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)
+    Parameters
-    if not resp.input_kind.startswith('text_'):
+    ----------
-        console.err.print(
+    input_name : str
-            f'Input [yellow]{input_name}[/yellow] is not a text input.',
+        The name of the text input to retrieve the current text from.
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
+    if not validate.input_in_inputs(ctx, input_name):
+        raise OBSWSCLIError(
+            f'Input [yellow]{input_name}[/yellow] not found.', code=ExitCode.ERROR
+        )
+
+    resp = ctx.client.get_input_settings(name=input_name)
+    if not resp.input_kind.startswith('text_'):
+        raise OBSWSCLIError(
+            f'Input [yellow]{input_name}[/yellow] is not a text input.',
+            code=ExitCode.ERROR,
         )
-        raise typer.Exit(1)
 
     current_text = resp.input_settings.get('text', '')
     if not current_text:
@@ -40,32 +48,40 @@ def current(
     )
 
 
-@app.command('update | set')
+@app.command(name=['update', 'set'])
 def update(
-    ctx: typer.Context,
+    input_name: str,
-    input_name: Annotated[
+    new_text: Optional[str] = None,
-        str, typer.Argument(help='Name of the text input to update.')
+    /,
-    ],
+    *,
-    new_text: Annotated[
+    ctx: Annotated[Context, Parameter(parse=False)],
-        Optional[str],
-        typer.Argument(
-            help='The new text to set for the input.',
-        ),
-    ] = None,
 ):
-    """Update the text of a text input."""
+    """Update the text of a text input.
+
+    Parameters
+    ----------
+    input_name : str
+        The name of the text input to update.
+    new_text : Optional[str]
+        The new text to set for the input. If not provided, the text will be cleared
+        (set to an empty string).
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
     if not validate.input_in_inputs(ctx, input_name):
-        console.err.print(f'Input [yellow]{input_name}[/yellow] not found.')
+        raise OBSWSCLIError(
-        raise typer.Exit(1)
+            f'Input [yellow]{input_name}[/yellow] not found.', code=ExitCode.ERROR
-
-    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(
+    resp = ctx.client.get_input_settings(name=input_name)
+    if not resp.input_kind.startswith('text_'):
+        raise OBSWSCLIError(
+            f'Input [yellow]{input_name}[/yellow] is not a text input.',
+            code=ExitCode.ERROR,
+        )
+
+    ctx.client.set_input_settings(
         name=input_name,
         settings={'text': new_text},
         overlay=True,

obsws_cli/validate.py

@@ -1,54 +1,49 @@
 """module containing validation functions."""
 
-import typer
+from .context import Context
-
-# 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:
+def input_in_inputs(ctx: Context, input_name: str) -> bool:
     """Check if an input is in the input list."""
-    inputs = ctx.obj['obsws'].get_input_list().inputs
+    inputs = ctx.client.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:
+def scene_in_scenes(ctx: Context, scene_name: str) -> bool:
     """Check if a scene exists in the list of scenes."""
-    resp = ctx.obj['obsws'].get_scene_list()
+    resp = ctx.client.get_scene_list()
     return any(scene.get('sceneName') == scene_name for scene in resp.scenes)
 
 
-def studio_mode_enabled(ctx: typer.Context) -> bool:
+def studio_mode_enabled(ctx: Context) -> bool:
     """Check if studio mode is enabled."""
-    resp = ctx.obj['obsws'].get_studio_mode_enabled()
+    resp = ctx.client.get_studio_mode_enabled()
     return resp.studio_mode_enabled
 
 
 def scene_collection_in_scene_collections(
-    ctx: typer.Context, scene_collection_name: str
+    ctx: Context, scene_collection_name: str
 ) -> bool:
     """Check if a scene collection exists."""
-    resp = ctx.obj['obsws'].get_scene_collection_list()
+    resp = ctx.client.get_scene_collection_list()
     return any(
         collection == scene_collection_name for collection in resp.scene_collections
     )
 
 
-def item_in_scene_item_list(
+def item_in_scene_item_list(ctx: Context, scene_name: str, item_name: str) -> bool:
-    ctx: typer.Context, scene_name: str, item_name: str
-) -> bool:
     """Check if an item exists in a scene."""
-    resp = ctx.obj['obsws'].get_scene_item_list(scene_name)
+    resp = ctx.client.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:
+def profile_exists(ctx: Context, profile_name: str) -> bool:
     """Check if a profile exists."""
-    resp = ctx.obj['obsws'].get_profile_list()
+    resp = ctx.client.get_profile_list()
     return any(profile == profile_name for profile in resp.profiles)
 
 
-def monitor_exists(ctx: typer.Context, monitor_index: int) -> bool:
+def monitor_exists(ctx: Context, monitor_index: int) -> bool:
     """Check if a monitor exists."""
-    resp = ctx.obj['obsws'].get_monitor_list()
+    resp = ctx.client.get_monitor_list()
     return any(monitor['monitorIndex'] == monitor_index for monitor in resp.monitors)

obsws_cli/virtualcam.py

@@ -1,46 +1,83 @@
 """module containing commands for manipulating virtual camera in OBS."""
 
-import typer
+from typing import Annotated
+
+from cyclopts import App, Parameter
 
 from . import console
-from .alias import SubTyperAliasGroup
+from .context import Context
 
-app = typer.Typer(cls=SubTyperAliasGroup)
+app = App(name='virtualcam', help='Commands for controlling the virtual camera in OBS.')
 
 
-@app.callback()
+@app.command(name=['start', 's'])
-def main():
+def start(
-    """Control virtual camera in OBS."""
+    *,
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Start the virtual camera.
 
+    Parameters
+    ----------
+    ctx : Context
+        The context containing the OBS client and other settings.
 
-@app.command('start | s')
+    """
-def start(ctx: typer.Context):
+    ctx.client.start_virtual_cam()
-    """Start the virtual camera."""
-    ctx.obj['obsws'].start_virtual_cam()
     console.out.print('Virtual camera started.')
 
 
-@app.command('stop | p')
+@app.command(name=['stop', 'p'])
-def stop(ctx: typer.Context):
+def stop(
-    """Stop the virtual camera."""
+    *,
-    ctx.obj['obsws'].stop_virtual_cam()
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Stop the virtual camera.
+
+    Parameters
+    ----------
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
+    ctx.client.stop_virtual_cam()
     console.out.print('Virtual camera stopped.')
 
 
-@app.command('toggle | tg')
+@app.command(name=['toggle', 'tg'])
-def toggle(ctx: typer.Context):
+def toggle(
-    """Toggle the virtual camera."""
+    *,
-    resp = ctx.obj['obsws'].toggle_virtual_cam()
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Toggle the virtual camera.
+
+    Parameters
+    ----------
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
+    resp = ctx.client.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 | ss')
+@app.command(name=['status', 'ss'])
-def status(ctx: typer.Context):
+def status(
-    """Get the status of the virtual camera."""
+    *,
-    resp = ctx.obj['obsws'].get_virtual_cam_status()
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get the status of the virtual camera.
+
+    Parameters
+    ----------
+    ctx : Context
+        The context containing the OBS client and other settings.
+
+    """
+    resp = ctx.client.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.8.0", "python-dotenv>=1.1.0"]
+dependencies = ["cyclopts>=3.22.2", "obsws-python>=1.8.0"]
 
 
 [project.urls]
@@ -30,7 +30,7 @@ Issues = "https://github.com/onyx-and-iris/obsws-cli/issues"
 Source = "https://github.com/onyx-and-iris/obsws-cli"
 
 [project.scripts]
-obsws-cli = "obsws_cli:app"
+obsws-cli = "obsws_cli:run"
 
 [tool.hatch.version]
 path = "obsws_cli/__about__.py"