Skip to content

Commit b07a6a1

Browse files
author
Ihar Hrachyshka
authored
Humanize CLI command group descriptions a bit (#137)
# What does this PR do? Descriptions were repetitive and verbose, some were truncated by click rendering (trailing ... ellipsis). This is an attempt to simplify / shorten / clarify the descriptions. [//]: # (If resolving an issue, uncomment and update the line below) [//]: # (Closes #[issue-number]) ## Test Plan Before: ```  llama-stack-client --help Usage: llama-stack-client [OPTIONS] COMMAND [ARGS]... Welcome to the LlamaStackClient CLI Options: --version Show the version and exit. --endpoint TEXT Llama Stack distribution endpoint --api-key TEXT Llama Stack distribution API key --config TEXT Path to config file --help Show this message and exit. Commands: configure Configure Llama Stack Client CLI datasets Query details about available datasets on Llama... eval Run evaluation tasks eval_tasks Query details about available eval tasks type on... inference Query details about available inference endpoints on... inspect Query details about available versions on Llama... models Query details about available models on Llama Stack... post_training Query details about available post_training... providers Query details about available providers on Llama... scoring_functions Manage scoring functions shields Query details about available safety shields on... toolgroups Query details about available toolgroups on Llama... vector_dbs Query details about available vector dbs on... ``` After: ```  llama-stack-client --help Usage: llama-stack-client [OPTIONS] COMMAND [ARGS]... Welcome to the LlamaStackClient CLI Options: --version Show the version and exit. --endpoint TEXT Llama Stack distribution endpoint --api-key TEXT Llama Stack distribution API key --config TEXT Path to config file --help Show this message and exit. Commands: configure Configure Llama Stack Client CLI. datasets Manage datasets. eval Run evaluation tasks. eval_tasks Manage evaluation tasks. inference Inference (chat). inspect Inspect server configuration. models Manage GenAI models. post_training Post-training. providers Manage API providers. scoring_functions Manage scoring functions. shields Manage safety shield services. toolgroups Manage available tool groups. vector_dbs Manage vector databases. ``` [//]: # (## Documentation) [//]: # (- [ ] Added a Changelog entry if the change is significant) Signed-off-by: Ihar Hrachyshka <[email protected]>
1 parent 626805a commit b07a6a1

File tree

13 files changed

+13
-25
lines changed

13 files changed

+13
-25
lines changed

src/llama_stack_client/lib/cli/configure.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def get_config():
2626
@click.option("--endpoint", type=str, help="Llama Stack distribution endpoint", default="")
2727
@click.option("--api-key", type=str, help="Llama Stack distribution API key", default="")
2828
def configure(endpoint: str | None, api_key: str | None):
29-
"""Configure Llama Stack Client CLI"""
29+
"""Configure Llama Stack Client CLI."""
3030
os.makedirs(LLAMA_STACK_CLIENT_CONFIG_DIR, exist_ok=True)
3131
config_path = get_config_file_path()
3232

src/llama_stack_client/lib/cli/datasets/datasets.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@
1111

1212
@click.group()
1313
def datasets():
14-
"""Query details about available datasets on Llama Stack distribution."""
15-
pass
14+
"""Manage datasets."""
1615

1716

1817
# Register subcommands

src/llama_stack_client/lib/cli/eval/eval.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@
1313

1414
@click.group()
1515
def eval():
16-
"""Run evaluation tasks"""
17-
pass
16+
"""Run evaluation tasks."""
1817

1918

2019
# Register subcommands

src/llama_stack_client/lib/cli/eval_tasks/eval_tasks.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@
1717

1818
@click.group()
1919
def eval_tasks():
20-
"""Query details about available eval tasks type on distribution."""
21-
pass
20+
"""Manage evaluation tasks."""
2221

2322

2423
@eval_tasks.command()

src/llama_stack_client/lib/cli/inference/inference.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@
1515

1616
@click.group()
1717
def inference():
18-
"""Query details about available inference endpoints on distribution."""
19-
pass
18+
"""Inference (chat)."""
2019

2120

2221
@click.command("chat-completion")

src/llama_stack_client/lib/cli/inspect/inspect.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@
55

66
@click.group()
77
def inspect():
8-
"""Query details about available versions on Llama Stack distribution."""
9-
pass
8+
"""Inspect server configuration."""
109

1110

1211
# Register subcommands

src/llama_stack_client/lib/cli/models/models.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@
1515

1616
@click.group()
1717
def models():
18-
"""Query details about available models on Llama Stack distribution."""
19-
pass
18+
"""Manage GenAI models."""
2019

2120

2221
@click.command(name="list", help="Show available llama models at distribution endpoint")

src/llama_stack_client/lib/cli/post_training/post_training.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@
1616

1717
@click.group()
1818
def post_training():
19-
"""Query details about available post_training endpoints on distribution."""
20-
pass
19+
"""Post-training."""
2120

2221

2322
@click.command("supervised_fine_tune")

src/llama_stack_client/lib/cli/providers/providers.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@
55

66
@click.group()
77
def providers():
8-
"""Query details about available providers on Llama Stack distribution."""
9-
pass
8+
"""Manage API providers."""
109

1110

1211
# Register subcommands

src/llama_stack_client/lib/cli/scoring_functions/scoring_functions.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@
1515

1616
@click.group()
1717
def scoring_functions():
18-
"""Manage scoring functions"""
19-
pass
18+
"""Manage scoring functions."""
2019

2120

2221
@scoring_functions.command()

0 commit comments

Comments
 (0)