Migrate all driver descriptions to DriverClickGroup decorator

Replace @click.group decorators with DriverClickGroup in all drivers, and use it to provide server-side driver description
In cli() use: base = DriverClickGroup(self, help="...")

The CLI client will retrieve customized driver's description via GetReport() from the exporter.
When there's no customization it falls back to locally provided default in help=.

Author: michalskrivanek

packages/jumpstarter-driver-composite/jumpstarter_driver_composite/client.py

@@ -5,6 +5,7 @@
 from rich import traceback
 
 from jumpstarter.client import DriverClient
+from jumpstarter.client.decorators import DriverClickGroup
 
 
 def _opt_log_level_callback(ctx, param, value):
@@ -34,18 +35,14 @@ def close(self):
                 v.close()
 
     def cli(self):
-        @click.group
-        @click.option(
+        base = DriverClickGroup(self, help="Generic composite device")
+        base.add_option(
             "--log-level",
-            "log_level",
             type=click.Choice(["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]),
             help="Set the log level",
             expose_value=False,
             callback=_opt_log_level_callback,
         )
-        def base():
-            """Generic composite device"""
-            pass
 
         for k, v in self.children.items():
             if hasattr(v, "cli"):

packages/jumpstarter-driver-flashers/jumpstarter_driver_flashers/client.py

@@ -21,6 +21,7 @@
 
 from jumpstarter_driver_flashers.bundle import FlasherBundleManifestV1Alpha1
 
+from jumpstarter.client.decorators import DriverClickGroup
 from jumpstarter.common.exceptions import ArgumentError
 
 debug_console_option = click.option("--console-debug", is_flag=True, help="Enable console debug mode")
@@ -750,10 +751,7 @@ def _validate_bearer_token(self, token: str | None) -> str | None:
         return token
 
     def cli(self):
-        @click.group
-        def base():
-            """Software-defined flasher interface"""
-            pass
+        base = DriverClickGroup(self, help="Software-defined flasher interface")
 
         @base.command()
         @click.argument("file")

packages/jumpstarter-driver-gpiod/jumpstarter_driver_gpiod/client.py

@@ -5,6 +5,7 @@
 from jumpstarter_driver_power.client import PowerClient
 
 from jumpstarter.client import DriverClient
+from jumpstarter.client.decorators import DriverClickGroup
 
 
 class PinState(Enum):
@@ -34,10 +35,7 @@ def read(self):
         return PinState(int(self.call("read_pin")))
 
     def cli(self):
-        @click.group()
-        def gpio():
-            """GPIO power control commands."""
-            pass
+        gpio = DriverClickGroup(self, help="GPIO power control commands.")
 
         for cmd in super().cli().commands.values():
             gpio.add_command(cmd)
@@ -79,10 +77,7 @@ def read(self):
         return PinState(int(self.call("read_pin")))
 
     def cli(self):
-        @click.group()
-        def gpio():
-            """GPIO input commands."""
-            pass
+        gpio = DriverClickGroup(self, help="GPIO input commands.")
 
         @gpio.command()
         def read():

packages/jumpstarter-driver-network/jumpstarter_driver_network/client.py

@@ -12,6 +12,7 @@
 from .driver import DbusNetwork
 from jumpstarter.client import DriverClient
 from jumpstarter.client.core import DriverMethodNotImplemented
+from jumpstarter.client.decorators import DriverClickGroup
 
 
 class NetworkClient(DriverClient):
@@ -20,10 +21,7 @@ def address(self):
         return self.call("address")
 
     def cli(self):
-        @click.group
-        def base():
-            """Generic Network Connection"""
-            pass
+        base = DriverClickGroup(self, help="Generic Network Connection")
 
         @base.command()
         @click.option("--address", default="localhost", show_default=True)

packages/jumpstarter-driver-opendal/jumpstarter_driver_opendal/client.py

@@ -19,6 +19,7 @@
 from .adapter import OpendalAdapter
 from .common import Capability, HashAlgo, Metadata, Mode, PathBuf, PresignedRequest
 from jumpstarter.client import DriverClient
+from jumpstarter.client.decorators import DriverClickGroup
 from jumpstarter.common.exceptions import ArgumentError
 from jumpstarter.streams.encoding import Compression
 
@@ -413,9 +414,7 @@ def cli(self):  # noqa: C901
         arg_dst = click.argument("dst", type=click.Path())
         opt_expire_second = click.option("--expire-second", type=int, required=True)
 
-        @click.group
-        def base():
-            """Opendal Storage"""
+        base = DriverClickGroup(self, help="Opendal Storage")
 
         @base.command
         @arg_path
@@ -548,10 +547,7 @@ def dump(
         ...
 
     def cli(self):
-        @click.group
-        def base():
-            """Generic flasher interface"""
-            pass
+        base = DriverClickGroup(self, help="Generic flasher interface")
 
         @base.command()
         @click.argument("file", nargs=-1, required=False)
@@ -716,7 +712,7 @@ def read_local_file(self, filepath):
 
     def cli(self, base=None):
         if base is None:
-            base = click.group(lambda: None)
+            base = DriverClickGroup(self, help="Storage operations")
 
         @base.command()
         def host():

packages/jumpstarter-driver-power/jumpstarter_driver_power/client.py

@@ -5,6 +5,7 @@
 
 from .common import PowerReading
 from jumpstarter.client import DriverClient
+from jumpstarter.client.decorators import DriverClickGroup
 
 
 class PowerClient(DriverClient):
@@ -35,10 +36,7 @@ def read(self) -> Generator[PowerReading, None, None]:
             yield PowerReading.model_validate(v, strict=True)
 
     def cli(self):
-        @click.group
-        def base():
-            """Generic power"""
-            pass
+        base = DriverClickGroup(self, help="Generic power")
 
         @base.command()
         def on():

packages/jumpstarter-driver-probe-rs/jumpstarter_driver_probe_rs/client.py

@@ -6,6 +6,7 @@
 from opendal import Operator
 
 from jumpstarter.client import DriverClient
+from jumpstarter.client.decorators import DriverClickGroup
 from jumpstarter.common.exceptions import ArgumentError
 
 
@@ -60,10 +61,7 @@ def read(self, width: int, address: int, words: int) -> list[int]:
         return [int(data, 16) for data in data_strs]
 
     def cli(self):  # noqa: C901
-        @click.group
-        def base():
-            """probe-rs client"""
-            pass
+        base = DriverClickGroup(self, help="probe-rs client")
 
         @base.command()
         def info():

packages/jumpstarter-driver-pyserial/jumpstarter_driver_pyserial/client.py

@@ -6,6 +6,7 @@
 
 from .console import Console
 from jumpstarter.client import DriverClient
+from jumpstarter.client.decorators import DriverClickGroup
 
 
 class PySerialClient(DriverClient):
@@ -36,10 +37,7 @@ def pexpect(self):
             yield adapter
 
     def cli(self):
-        @click.group
-        def base():
-            """Serial port client"""
-            pass
+        base = DriverClickGroup(self, help="Serial port client")
 
         @base.command()
         def start_console():

packages/jumpstarter-driver-ridesx/jumpstarter_driver_ridesx/client.py

@@ -2,12 +2,13 @@
 from pathlib import Path
 from typing import Dict, Optional
 
-import click
 from jumpstarter_driver_composite.client import CompositeClient
 from jumpstarter_driver_opendal.client import FlasherClient, operator_for_path
 from jumpstarter_driver_power.client import PowerClient
 from opendal import Operator
 
+from jumpstarter.client.decorators import DriverClickGroup
+
 PROMPT = "CMD >> "
 
 
@@ -102,9 +103,7 @@ def flash(
     def cli(self):
         generic_cli = FlasherClient.cli(self)
 
-        @click.group()
-        def storage():
-            pass
+        storage = DriverClickGroup(self, help="RideSX storage operations")
 
         for name, cmd in generic_cli.commands.items():
             storage.add_command(cmd, name=name)

packages/jumpstarter-driver-shell/jumpstarter_driver_shell/client.py

@@ -4,6 +4,7 @@
 import click
 
 from jumpstarter.client import DriverClient
+from jumpstarter.client.decorators import DriverClickGroup
 
 
 @dataclass(kw_only=True)
@@ -41,10 +42,7 @@ def execute(*args, **kwargs):
 
     def cli(self):
         """Create CLI interface for dynamically configured shell methods"""
-        @click.group
-        def base():
-            """Shell command executor"""
-            pass
+        base = DriverClickGroup(self, help="Shell command executor")
 
         # Get available methods from the driver
         if self._methods is None:
@@ -80,12 +78,12 @@ def method_command(args, env):
         except Exception:
             description = f"Execute the {method_name} shell method"
 
-        # Decorate and register the command
-        method_command.__doc__ = description
+        # Decorate and register the command with help text
         method_command = click.argument('args', nargs=-1, type=click.UNPROCESSED)(method_command)
         method_command = click.option('--env', '-e', multiple=True,
                      help='Environment variables in KEY=VALUE format')(method_command)
         method_command = group.command(
             name=method_name,
+            help=description,
             context_settings={"ignore_unknown_options": True, "allow_interspersed_args": False},
         )(method_command)