From de1c604c4610e4583edd259f8238e3f1b45106e7 Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Thu, 24 Jul 2025 01:38:42 +0100 Subject: [PATCH] update the --help message add descriptions for filter + scene command groups Usage now after main CLI description --- obsws_cli/app.py | 6 ++++-- obsws_cli/filter.py | 2 +- obsws_cli/scene.py | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/obsws_cli/app.py b/obsws_cli/app.py index 9c0deab..30a7f30 100644 --- a/obsws_cli/app.py +++ b/obsws_cli/app.py @@ -19,9 +19,11 @@ app = App( '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('Session Parameters', sort_key=0) +app.meta.group_parameters = Group('Options', sort_key=0) for sub_app in ( + 'group', 'filter', 'scene', ): @@ -74,7 +76,7 @@ def launcher( Parameter(validator=setup_logging), ] = False, ): - """Initialize the OBS WebSocket client and return the context.""" + """Command line interface for the OBS WebSocket API.""" with obsws.ReqClient( host=obs_config.host, port=obs_config.port, diff --git a/obsws_cli/filter.py b/obsws_cli/filter.py index 596fd4f..67a023a 100644 --- a/obsws_cli/filter.py +++ b/obsws_cli/filter.py @@ -12,7 +12,7 @@ from .context import Context from .enum import ExitCode from .error import OBSWSCLIError -app = App(name='filter') +app = App(name='filter', help='Commands for managing filters in OBS sources') @app.command(name=['list', 'ls']) diff --git a/obsws_cli/scene.py b/obsws_cli/scene.py index 5072afa..5dcb27e 100644 --- a/obsws_cli/scene.py +++ b/obsws_cli/scene.py @@ -11,7 +11,7 @@ from .context import Context from .enum import ExitCode from .error import OBSWSCLIError -app = App(name='scene') +app = App(name='scene', help='Commands for managing OBS scenes') @app.command(name=['list', 'ls'])