From a3f6996d69c37235771e110fb020da8a1eb9316b Mon Sep 17 00:00:00 2001 From: a-kenji Date: Fri, 26 Apr 2024 11:42:18 +0200 Subject: [PATCH] clan(help): improve install description --- pkgs/clan-cli/clan_cli/machines/__init__.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/pkgs/clan-cli/clan_cli/machines/__init__.py b/pkgs/clan-cli/clan_cli/machines/__init__.py index 3a3c9a5b..4c4bf83f 100644 --- a/pkgs/clan-cli/clan_cli/machines/__init__.py +++ b/pkgs/clan-cli/clan_cli/machines/__init__.py @@ -29,5 +29,13 @@ def register_parser(parser: argparse.ArgumentParser) -> None: list_parser = subparser.add_parser("list", help="List machines") register_list_parser(list_parser) - install_parser = subparser.add_parser("install", help="Install a machine") + install_parser = subparser.add_parser( + "install", + help="Install a machine", + description=""" + Install a configured machine over the network. + The target must be a Linux based system reachable via SSH. + Installing a machine means overwriting the target's disk. + """, + ) register_install_parser(install_parser)