Add help text to subcommands.

This way they appear better in the console.
This commit is contained in:
Sebastian Lenzlinger 2024-05-08 03:53:17 +02:00
parent 3bbbbe52c0
commit 18cdd1dd46
2 changed files with 4 additions and 2 deletions

View File

@ -21,7 +21,8 @@ def setup_argparse():
# Utility to list interfaces directly with iottb instead of relying on external tooling
interfaces_parser = subparsers.add_parser('list-interfaces', aliases=['li', 'if'])
interfaces_parser = subparsers.add_parser('list-interfaces', aliases=['li', 'if'],
help='List available network interfaces.')
interfaces_parser.set_defaults(func=list_interfaces)
return root_parser

View File

@ -10,7 +10,8 @@ logger.setLevel(logging.INFO) # Since module currently passes all tests
def setup_init_device_root_parser(subparsers):
parser = subparsers.add_parser('add-device', aliases=['add-device-root', 'add'])
parser = subparsers.add_parser('add-device', aliases=['add-device-root', 'add'],
help='Initialize a folder for a device.')
parser.add_argument('--root_dir', type=pathlib.Path, default=pathlib.Path.cwd())
group = parser.add_mutually_exclusive_group()
group.add_argument('--guided', action='store_true', help='Guided setup', default=False)