From f63c5ab12863c6b7db73d93c5ef2ab38895d7c4f Mon Sep 17 00:00:00 2001 From: a-kenji Date: Mon, 27 May 2024 20:14:37 +0200 Subject: [PATCH] clan: `ssh --help` add examples Add examples to the output of `clan ssh --help`. --- pkgs/clan-cli/clan_cli/__init__.py | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/pkgs/clan-cli/clan_cli/__init__.py b/pkgs/clan-cli/clan_cli/__init__.py index a964c9708..25d956bfd 100644 --- a/pkgs/clan-cli/clan_cli/__init__.py +++ b/pkgs/clan-cli/clan_cli/__init__.py @@ -151,7 +151,25 @@ For more detailed information, visit: https://docs.clan.lol/getting-started ) config.register_parser(parser_config) - parser_ssh = subparsers.add_parser("ssh", help="ssh to a remote machine") + parser_ssh = subparsers.add_parser( + "ssh", + help="ssh to a remote machine", + epilog=( + """ +This subcommand allows seamless ssh access to the nixos-image builders. + +Examples: + + $ clan ssh [ssh_args ...] --json [JSON] + Will ssh in to the machine based on the deployment information contained in + the json string. [JSON] can either be a json formatted string itself, or point + towards a file containing the deployment information + +For more detailed information, visit: https://docs.clan.lol/getting-started/deploy + """ + ), + formatter_class=argparse.RawTextHelpFormatter, + ) ssh_cli.register_parser(parser_ssh) parser_secrets = subparsers.add_parser(