onyx_online/obsws-cli
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/obsws-cli.git synced 2025-08-06 20:01:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

update the --help message

Browse Source 
add descriptions for filter + scene command groups

Usage now after main CLI description
This commit is contained in:
onyx-and-iris 2025-07-24 01:38:42 +01:00
parent 105aaf29b7
commit de1c604c46
3 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
obsws_cli/app.py
View File

@ -19,9 +19,11 @@ app = App(
'OBS_' 'OBS_'
), # Environment variable prefix for configuration parameters ), # Environment variable prefix for configuration parameters
version=version, 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 ( for sub_app in (
'group',
'filter', 'filter',
'scene', 'scene',
): ):
@ -74,7 +76,7 @@ def launcher(
Parameter(validator=setup_logging), Parameter(validator=setup_logging),
] = False, ] = False,
): ):
"""Initialize the OBS WebSocket client and return the context.""" """Command line interface for the OBS WebSocket API."""
with obsws.ReqClient( with obsws.ReqClient(
host=obs_config.host, host=obs_config.host,
port=obs_config.port, port=obs_config.port,

2
obsws_cli/filter.py
View File

@ -12,7 +12,7 @@ from .context import Context
from .enum import ExitCode from .enum import ExitCode
from .error import OBSWSCLIError 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']) @app.command(name=['list', 'ls'])

2
obsws_cli/scene.py
View File

@ -11,7 +11,7 @@ from .context import Context
from .enum import ExitCode from .enum import ExitCode
from .error import OBSWSCLIError from .error import OBSWSCLIError
app = App(name='scene') app = App(name='scene', help='Commands for managing OBS scenes')
@app.command(name=['list', 'ls']) @app.command(name=['list', 'ls'])