upd call to vban_cmd

minor bump

README.md

@@ -5,8 +5,6 @@
 
 ---
 
-This CLI is still in an early stage of development with many more things that could be implemented. However, the commands that are implemented should be working without issues.
-
 ## Install
 
 #### With uv
@@ -51,7 +49,7 @@ export VBAN_CLI_STREAMNAME=Command1
 
 ### Strip Command
 
-Usage: vban-cli strip \<index> COMMAND [ARGS]
+*Usage: vban-cli strip \<index> COMMAND [OPTIONS]*
 
 examples:
 
@@ -65,9 +63,9 @@ vban-cli strip 2 gain -18.7
 
 see `vban-cli strip --help` for more info.
 
-#### Strip EQ
+##### Strip EQ
 
-Usage: vban-cli strip \<index> eq COMMAND [OPTIONS]
+*Usage: vban-cli strip \<index> eq COMMAND [OPTIONS]*
 
 examples:
 
@@ -77,9 +75,9 @@ vban-cli strip 0 eq on true
 
 see `vban-cli strip eq --help` for more info.
 
-#### Strip EQ Cell Command
+##### Strip EQ Cell Command
 
-Usage: vban-cli strip \<index> eq cell \<band> COMMAND [ARGS]
+*Usage: vban-cli strip \<index> eq cell \<band> COMMAND [ARGS]*
 
 examples:
 
@@ -93,9 +91,37 @@ vban-cli strip 4 eq cell 5 type 5
 
 see `vban-cli strip eq cell --help` for more info.
 
-#### Strip Gainlayer Command
+##### Strip Comp Command
 
-Usage: vban-cli strip \<index> gainlayer \<gainlayer_index> COMMAND [OPTIONS] [ARGS]
+*Usage: vban-cli strip \<index> comp COMMAND [OPTIONS]*
+
+examples:
+
+```console
+vban-cli strip 0 comp attack 2.0
+
+vban-cli strip 3 comp auto-makeup true
+```
+
+see `vban-cli strip comp --help` for more info.
+
+##### Strip Gate Command
+
+*Usage: vban-cli strip \<index> gate COMMAND [OPTIONS]*
+
+examples:
+
+```console
+vban-cli strip 2 gate attack 634
+
+vban-cli strip 5 gate hold 2088.7
+```
+
+see `vban-cli strip comp --help` for more info.
+
+##### Strip Gainlayer Command
+
+*Usage: vban-cli strip \<index> gainlayer \<gainlayer_index> COMMAND [OPTIONS] [ARGS]*
 
 examples:
 
@@ -109,7 +135,7 @@ see `vban-cli strip gainlayer --help` for more info.
 
 ### Bus Command
 
-Usage: vban-cli bus \<index> COMMAND [ARGS]
+*Usage: vban-cli bus \<index> COMMAND [OPTIONS]*
 
 examples:
 
@@ -123,7 +149,7 @@ see `vban-cli bus --help` for more info.
 
 ### Command Command
 
-Usage: vban-cli command COMMAND
+*Usage: vban-cli command COMMAND*
 
 examples:
 
@@ -137,7 +163,7 @@ see `vban-cli command --help` for more info.
 
 ### Recorder Command
 
-Usage: vban-cli recorder COMMAND
+*Usage: vban-cli recorder COMMAND*
 
 examples:
 
@@ -153,7 +179,7 @@ see `vban-cli recorder --help` for more info.
 
 ### Sendtext Command
 
-Usage: vban-cli sendtext TEXT
+*Usage: vban-cli sendtext TEXT*
 
 examples:
 

pyproject.toml

@@ -1,13 +1,13 @@
 [project]
 name = "vban-cli"
-version = "0.9.3"
+version = "0.12.0"
 description = "A command-line interface for Voicemeeter leveraging VBAN."
 readme = "README.md"
 license = { text = "LICENSE" }
 requires-python = ">=3.13"
-dependencies = ["cyclopts>=4.6.0", "loguru>=0.7.3", "vban-cmd>=2.8.1"]
+dependencies = ["cyclopts>=4.6.0", "loguru>=0.7.3", "vban-cmd>=2.9.1"]
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 4 - Beta",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",

src/vban_cli/app.py

@@ -53,7 +53,7 @@ def launcher(
     try:
         with vban_cmd.api(
             vban_config.kind,
-            ip=vban_config.host,
+            host=vban_config.host,
             port=vban_config.port,
             streamname=vban_config.streamname,
             disable_rt_listeners=disable_rt_listeners,

src/vban_cli/comp.py

@@ -63,3 +63,150 @@ def input_gain(
         # app.console.print(ctx.client.strip[index].comp.gainin)
         return
     ctx.client.strip[index].comp.gainin = new_gain
+
+
+@app.command(name='ratio')
+def ratio(
+    new_ratio: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(parse=False)],
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get or set the ratio of the specified compressor.
+
+    Parameters
+    ----------
+    new_ratio : float, optional
+        If provided, sets the ratio to this value. If not provided, the current ratio is printed.
+    """
+    if new_ratio is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # app.console.print(ctx.client.strip[index].comp.ratio)
+        return
+    ctx.client.strip[index].comp.ratio = new_ratio
+
+
+@app.command(name='threshold')
+def threshold(
+    new_threshold: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(parse=False)],
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get or set the threshold of the specified compressor.
+
+    Parameters
+    ----------
+    new_threshold : float, optional
+        If provided, sets the threshold to this value. If not provided, the current threshold is printed.
+    """
+    if new_threshold is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # app.console.print(ctx.client.strip[index].comp.threshold)
+        return
+    ctx.client.strip[index].comp.threshold = new_threshold
+
+
+@app.command(name='attack')
+def attack(
+    new_attack: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(parse=False)],
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get or set the attack of the specified compressor.
+
+    Parameters
+    ----------
+    new_attack : float, optional
+        If provided, sets the attack to this value. If not provided, the current attack is printed.
+    """
+    if new_attack is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # app.console.print(ctx.client.strip[index].comp.attack)
+        return
+    ctx.client.strip[index].comp.attack = new_attack
+
+
+@app.command(name='release')
+def release(
+    new_release: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(parse=False)],
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get or set the release of the specified compressor.
+
+    Parameters
+    ----------
+    new_release : float, optional
+        If provided, sets the release to this value. If not provided, the current release is printed.
+    """
+    if new_release is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # app.console.print(ctx.client.strip[index].comp.release)
+        return
+    ctx.client.strip[index].comp.release = new_release
+
+
+@app.command(name='knee')
+def knee(
+    new_knee: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(parse=False)],
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get or set the knee of the specified compressor.
+
+    Parameters
+    ----------
+    new_knee : float, optional
+        If provided, sets the knee to this value. If not provided, the current knee is printed.
+    """
+    if new_knee is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # app.console.print(ctx.client.strip[index].comp.knee)
+        return
+    ctx.client.strip[index].comp.knee = new_knee
+
+
+@app.command(name='output-gain')
+def output_gain(
+    new_gain: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(parse=False)],
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get or set the output gain of the specified compressor.
+
+    Parameters
+    ----------
+    new_gain : float, optional
+        If provided, sets the output gain to this value. If not provided, the current output gain is printed.
+    """
+    if new_gain is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # app.console.print(ctx.client.strip[index].comp.gainout)
+        return
+    ctx.client.strip[index].comp.gainout = new_gain
+
+
+@app.command(name='auto-makeup')
+def makeup(
+    new_makeup: Annotated[bool, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(parse=False)],
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get or set the auto-makeup of the specified compressor.
+
+    Parameters
+    ----------
+    new_makeup : bool, optional
+        If provided, sets the auto-makeup to this value. If not provided, the current auto-makeup is printed.
+    """
+    if new_makeup is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # app.console.print(ctx.client.strip[index].comp.makeup)
+        return
+    ctx.client.strip[index].comp.makeup = new_makeup

src/vban_cli/gate.py

@@ -63,3 +63,108 @@ def threshold(
         # app.console.print(ctx.client.strip[index].gate.threshold)
         return
     ctx.client.strip[index].gate.threshold = new_threshold
+
+
+@app.command(name='damping-max')
+def damping_max(
+    new_damping_max: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(parse=False)],
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get or set the damping max of the specified gate.
+
+    Parameters
+    ----------
+    new_damping_max : float, optional
+        If provided, sets the damping max to this value. If not provided, the current damping max is printed.
+    """
+    if new_damping_max is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # app.console.print(ctx.client.strip[index].gate.damping)
+        return
+    ctx.client.strip[index].gate.damping = new_damping_max
+
+
+@app.command(name='bp-sidechain')
+def bp_sidechain(
+    new_bp_sidechain: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(parse=False)],
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get or set the BP sidechain of the specified gate.
+
+    Parameters
+    ----------
+    new_bp_sidechain : float, optional
+        If provided, sets the BP sidechain to this value. If not provided, the current BP sidechain is printed.
+    """
+    if new_bp_sidechain is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # app.console.print(ctx.client.strip[index].gate.bpsidechain)
+        return
+    ctx.client.strip[index].gate.bpsidechain = new_bp_sidechain
+
+
+@app.command(name='attack')
+def attack(
+    new_attack: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(parse=False)],
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get or set the attack of the specified gate.
+
+    Parameters
+    ----------
+    new_attack : float, optional
+        If provided, sets the attack to this value. If not provided, the current attack is printed.
+    """
+    if new_attack is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # app.console.print(ctx.client.strip[index].gate.attack)
+        return
+    ctx.client.strip[index].gate.attack = new_attack
+
+
+@app.command(name='hold')
+def hold(
+    new_hold: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(parse=False)],
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get or set the hold of the specified gate.
+
+    Parameters
+    ----------
+    new_hold : float, optional
+        If provided, sets the hold to this value. If not provided, the current hold is printed.
+    """
+    if new_hold is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # app.console.print(ctx.client.strip[index].gate.hold)
+        return
+    ctx.client.strip[index].gate.hold = new_hold
+
+
+@app.command(name='release')
+def release(
+    new_release: Annotated[float, Argument()] = None,
+    *,
+    index: Annotated[int, Parameter(parse=False)],
+    ctx: Annotated[Context, Parameter(parse=False)],
+):
+    """Get or set the release of the specified gate.
+
+    Parameters
+    ----------
+    new_release : float, optional
+        If provided, sets the release to this value. If not provided, the current release is printed.
+    """
+    if new_release is None:
+        # See https://github.com/onyx-and-iris/vban-cli?tab=readme-ov-file#implementation-notes - 2.
+        # app.console.print(ctx.client.strip[index].gate.release)
+        return
+    ctx.client.strip[index].gate.release = new_release

src/vban_cli/help.py

@@ -56,8 +56,16 @@ class StripHelpFormatter(BaseHelpFormatter):
             )
             if modified_usage == str(usage):
                 modified_usage = re.sub(
-                    r'(\S+\s+strip)\s+(\w+)', r'\1 <index> \2', str(usage)
+                    r'(\S+\s+strip)\s+(\w+)',
+                    r'\1 <index> \2 [OPTIONS] [ARGS]',
+                    str(usage),
                 )
+            # Handle main strip command and subcommand groups
+            modified_usage = re.sub(
+                r'\bCOMMAND\b(?!\s+\[)', 'COMMAND [OPTIONS]', modified_usage
+            )
+            # Remove the duplicate INDEX that gets automatically added by cyclopts
+            modified_usage = re.sub(r'\s+INDEX$', '', modified_usage)
             console.print(f'[bold]Usage:[/bold] {modified_usage}')
 
 
@@ -76,8 +84,16 @@ class BusHelpFormatter(BaseHelpFormatter):
             )
             if modified_usage == str(usage):
                 modified_usage = re.sub(
-                    r'(\S+\s+bus)\s+(\w+)', r'\1 <index> \2', str(usage)
+                    r'(\S+\s+bus)\s+(\w+)',
+                    r'\1 <index> \2 [OPTIONS] [ARGS]',
+                    str(usage),
                 )
+            # Handle main bus command and subcommand groups
+            modified_usage = re.sub(
+                r'\bCOMMAND\b(?!\s+\[)', 'COMMAND [OPTIONS]', modified_usage
+            )
+            # Remove the duplicate INDEX that gets automatically added by cyclopts
+            modified_usage = re.sub(r'\s+INDEX$', '', modified_usage)
             console.print(f'[bold]Usage:[/bold] {modified_usage}')
 
 
@@ -90,7 +106,9 @@ class EqHelpFormatter(BaseHelpFormatter):
         """Render the usage line with proper <index> placement for both strip and bus commands."""
         if usage:
             modified_usage = re.sub(
-                r'(\S+\s+)(\w+)(\s+eq\s+)(COMMAND)', r'\1\2 <index>\3\4', str(usage)
+                r'(\S+\s+)(\w+)(\s+eq\s+)(COMMAND)',
+                r'\1\2 <index>\3\4 [OPTIONS]',
+                str(usage),
             )
             console.print(f'[bold]Usage:[/bold] {modified_usage}')
 
@@ -105,9 +123,11 @@ class GainlayerHelpFormatter(BaseHelpFormatter):
         if usage:
             modified_usage = re.sub(
                 r'(\S+\s+strip)(\s+gainlayer\s+)(COMMAND)',
-                r'\1 <index>\2<[cyan]gainlayer_index[/cyan]> \3',
+                r'\1 <index>\2<[cyan]gainlayer_index[/cyan]> \3 [OPTIONS] [ARGS]',
                 str(usage),
             )
+            # Remove the duplicate GAINLAYER_INDEX that gets automatically added by cyclopts
+            modified_usage = re.sub(r'\s+GAINLAYER_INDEX$', '', modified_usage)
             console.print(f'[bold]Usage:[/bold] {modified_usage}')
 
 
@@ -121,7 +141,9 @@ class CellHelpFormatter(BaseHelpFormatter):
         if usage:
             modified_usage = re.sub(
                 r'(\S+\s+)(\w+)(\s+eq\s+cell\s+)(COMMAND)',
-                r'\1\2 <index>\3<[cyan]band[/cyan]> \4',
+                r'\1\2 <index>\3<[cyan]band[/cyan]> \4 [ARGS]',
                 str(usage),
             )
+            # Remove the duplicate BAND that gets automatically added by cyclopts
+            modified_usage = re.sub(r'\s+BAND$', '', modified_usage)
             console.print(f'[bold]Usage:[/bold] {modified_usage}')

uv.lock

@@ -124,7 +124,7 @@ wheels = [
 
 [[package]]
 name = "vban-cli"
-version = "0.9.3"
+version = "0.12.0"
 source = { editable = "." }
 dependencies = [
     { name = "cyclopts" },
@@ -141,7 +141,7 @@ requires-dist = [
 
 [[package]]
 name = "vban-cmd"
-version = "2.8.1"
+version = "2.9.1"
 source = { editable = "../vban-cmd-python" }
 
 [package.metadata]