Skip to content

Commit 8d18bdc

Browse files
tpoliawabbiemery
authored andcommitted
Add help text to host option and make -h lowercase
1 parent f51f2dc commit 8d18bdc

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

src/blueapi/cli/cli.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,19 @@ def is_str_dict(val: Any) -> TypeGuard[TaskParameters]:
8181
invoke_without_command=True, context_settings={"auto_envvar_prefix": "BLUEAPI"}
8282
)
8383
@click.version_option(version=__version__, prog_name="blueapi")
84-
@click.option("-H", "--host", type=str)
84+
@click.option(
85+
"-h",
86+
"--host",
87+
type=str,
88+
help=textwrap.dedent(
89+
"""
90+
Hostname for the blueapi instance to use
91+
92+
Value should be the full URL including scheme (and port if non-default),
93+
eg `--host http://localhost:8000`
94+
"""
95+
),
96+
)
8597
@click.option(
8698
"-c", "--config", type=Path, help="Path to configuration YAML file", multiple=True
8799
)

0 commit comments

Comments
 (0)