Migrate all drivers to use driver_click_group or driver_click_command decorator

Replace @click.group decorators with @driver_click_group and @click.command with @driver_click_command in all drivers,
and use it to provide server-side driver description.

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 docstring or 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 driver_click_group
 
 
 def _opt_log_level_callback(ctx, param, value):
@@ -34,18 +35,18 @@ def close(self):
                 v.close()
 
     def cli(self):
-        @click.group
-        @click.option(
+        @driver_click_group(self)
+        def base():
+            """Generic composite device"""
+            pass
+
+        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 driver_click_group
 from jumpstarter.common.exceptions import ArgumentError
 
 debug_console_option = click.option("--console-debug", is_flag=True, help="Enable console debug mode")
@@ -750,7 +751,7 @@ def _validate_bearer_token(self, token: str | None) -> str | None:
         return token
 
     def cli(self):
-        @click.group
+        @driver_click_group(self)
         def base():
             """Software-defined flasher interface"""
             pass

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 driver_click_group
 
 
 class PinState(Enum):
@@ -34,7 +35,7 @@ def read(self):
         return PinState(int(self.call("read_pin")))
 
     def cli(self):
-        @click.group()
+        @driver_click_group(self)
         def gpio():
             """GPIO power control commands."""
             pass
@@ -79,7 +80,7 @@ def read(self):
         return PinState(int(self.call("read_pin")))
 
     def cli(self):
-        @click.group()
+        @driver_click_group(self)
         def gpio():
             """GPIO input commands."""
             pass

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 driver_click_group
 
 
 class NetworkClient(DriverClient):
@@ -20,7 +21,7 @@ def address(self):
         return self.call("address")
 
     def cli(self):
-        @click.group
+        @driver_click_group(self)
         def base():
             """Generic Network Connection"""
             pass

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 driver_click_group
 from jumpstarter.common.exceptions import ArgumentError
 from jumpstarter.streams.encoding import Compression
 
@@ -413,9 +414,10 @@ 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
+        @driver_click_group(self)
         def base():
             """Opendal Storage"""
+            pass
 
         @base.command
         @arg_path
@@ -548,7 +550,7 @@ def dump(
         ...
 
     def cli(self):
-        @click.group
+        @driver_click_group(self)
         def base():
             """Generic flasher interface"""
             pass
@@ -716,7 +718,10 @@ def read_local_file(self, filepath):
 
     def cli(self, base=None):
         if base is None:
-            base = click.group(lambda: None)
+            @driver_click_group(self)
+            def base():
+                """Storage operations"""
+                pass
 
         @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 driver_click_group
 
 
 class PowerClient(DriverClient):
@@ -35,7 +36,7 @@ def read(self) -> Generator[PowerReading, None, None]:
             yield PowerReading.model_validate(v, strict=True)
 
     def cli(self):
-        @click.group
+        @driver_click_group(self)
         def base():
             """Generic power"""
             pass

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 driver_click_group
 from jumpstarter.common.exceptions import ArgumentError
 
 
@@ -60,7 +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
+        @driver_click_group(self)
         def base():
             """probe-rs client"""
             pass

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 driver_click_group
 
 
 class PySerialClient(DriverClient):
@@ -36,7 +37,7 @@ def pexpect(self):
             yield adapter
 
     def cli(self):
-        @click.group
+        @driver_click_group(self)
         def base():
             """Serial port client"""
             pass

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 driver_click_group
+
 PROMPT = "CMD >> "
 
 
@@ -102,8 +103,9 @@ def flash(
     def cli(self):
         generic_cli = FlasherClient.cli(self)
 
-        @click.group()
+        @driver_click_group(self)
         def storage():
+            """RideSX storage operations"""
             pass
 
         for name, cmd in generic_cli.commands.items():

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 driver_click_group
 
 
 @dataclass(kw_only=True)
@@ -41,7 +42,7 @@ def execute(*args, **kwargs):
 
     def cli(self):
         """Create CLI interface for dynamically configured shell methods"""
-        @click.group
+        @driver_click_group(self)
         def base():
             """Shell command executor"""
             pass
@@ -80,12 +81,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)