Skip to content

Commit 3ee41da

Browse files
authored
CLI doc update (#224)
# What does this PR do? The cli_reference.md was re-generated with the updated generator A small change in the doc generator to have the full help text (80 characters) instead of the short one (which is truncated after 45 chars) for the commands [//]: # (If resolving an issue, uncomment and update the line below) [//]: # (Closes #[issue-number]) ## Test Plan [Describe the tests you ran to verify your changes with result summaries. *Provide clear instructions so the plan can be easily re-executed.*] [//]: # (## Documentation) [//]: # (- [ ] Added a Changelog entry if the change is significant) --------- Signed-off-by: Josh Salomon <jsalomon@redhat.com>
1 parent 05e41a6 commit 3ee41da

File tree

2 files changed

+58
-22
lines changed

2 files changed

+58
-22
lines changed

docs/cli_reference.md

Lines changed: 57 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,12 @@ Usage: llama-stack-client datasets [OPTIONS] COMMAND [ARGS]...
8080

8181
**Commands**
8282

83-
* **list**: Show available datasets on distribution...
83+
* **list**: Show available datasets on distribution endpoint
8484

8585
* **register**: Create a new dataset
8686

87+
* **unregister**: Remove a dataset
88+
8789

8890

8991
### list
@@ -114,17 +116,31 @@ Usage: llama-stack-client datasets register [OPTIONS]
114116

115117
* **--dataset-id**: Id of the dataset
116118

117-
* **--provider-id**: Provider ID for the dataset
118-
119-
* **--provider-dataset-id**: Provider's dataset ID
119+
* **--purpose**: Purpose of the dataset
120120

121121
* **--metadata**: Metadata of the dataset
122122

123123
* **--url**: URL of the dataset
124124

125125
* **--dataset-path**: Local file path to the dataset. If specified, upload dataset via URL
126126

127-
* **--schema**: JSON schema of the dataset
127+
128+
129+
### unregister
130+
131+
Remove a dataset
132+
133+
```
134+
Usage: llama-stack-client datasets unregister [OPTIONS] DATASET_ID
135+
```
136+
137+
**Options**
138+
139+
* **-h, --help**: Show this message and exit. [default: False]
140+
141+
**Arguments**
142+
143+
* **DATASET_ID**
128144

129145

130146

@@ -226,7 +242,7 @@ Usage: llama-stack-client eval-tasks [OPTIONS] COMMAND [ARGS]...
226242

227243
**Commands**
228244

229-
* **list**: Show available eval tasks on distribution...
245+
* **list**: Show available eval tasks on distribution endpoint
230246

231247
* **register**: Register a new eval task
232248

@@ -286,7 +302,7 @@ Usage: llama-stack-client inference [OPTIONS] COMMAND [ARGS]...
286302

287303
**Commands**
288304

289-
* **chat-completion**: Show available inference chat completion...
305+
* **chat-completion**: Show available inference chat completion endpoints on distribution endpoint
290306

291307

292308

@@ -326,7 +342,7 @@ Usage: llama-stack-client inspect [OPTIONS] COMMAND [ARGS]...
326342

327343
**Commands**
328344

329-
* **version**: Show available providers on distribution...
345+
* **version**: Show available providers on distribution endpoint
330346

331347

332348

@@ -358,9 +374,9 @@ Usage: llama-stack-client models [OPTIONS] COMMAND [ARGS]...
358374

359375
**Commands**
360376

361-
* **get**: Show available llama models at distribution...
377+
* **get**: Show details of a specific model at the distribution endpoint
362378

363-
* **list**: Show available llama models at distribution...
379+
* **list**: Show available llama models at distribution endpoint
364380

365381
* **register**: Register a new model at distribution endpoint
366382

@@ -370,7 +386,7 @@ Usage: llama-stack-client models [OPTIONS] COMMAND [ARGS]...
370386

371387
### get
372388

373-
Show available llama models at distribution endpoint
389+
Show details of a specific model at the distribution endpoint
374390

375391
```
376392
Usage: llama-stack-client models get [OPTIONS] MODEL_ID
@@ -456,13 +472,13 @@ Usage: llama-stack-client post-training [OPTIONS] COMMAND [ARGS]...
456472

457473
**Commands**
458474

459-
* **artifacts**: Get the training artifacts of a specific post...
475+
* **artifacts**: Get the training artifacts of a specific post training job
460476

461477
* **cancel**: Cancel the training job
462478

463479
* **list**: Show the list of available post training jobs
464480

465-
* **status**: Show the status of a specific post training...
481+
* **status**: Show the status of a specific post training job
466482

467483
* **supervised_fine_tune**: Kick off a supervised fine tune job
468484

@@ -569,7 +585,27 @@ Usage: llama-stack-client providers [OPTIONS] COMMAND [ARGS]...
569585

570586
**Commands**
571587

572-
* **list**: Show available providers on distribution...
588+
* **inspect**: Show available providers on distribution endpoint
589+
590+
* **list**: Show available providers on distribution endpoint
591+
592+
593+
594+
### inspect
595+
596+
Show available providers on distribution endpoint
597+
598+
```
599+
Usage: llama-stack-client providers inspect [OPTIONS] PROVIDER_ID
600+
```
601+
602+
**Options**
603+
604+
* **--help**: Show this message and exit. [default: False]
605+
606+
**Arguments**
607+
608+
* **PROVIDER_ID**
573609

574610

575611

@@ -601,7 +637,7 @@ Usage: llama-stack-client scoring-functions [OPTIONS] COMMAND [ARGS]...
601637

602638
**Commands**
603639

604-
* **list**: Show available scoring functions on...
640+
* **list**: Show available scoring functions on distribution endpoint
605641

606642
* **register**: Register a new scoring function
607643

@@ -661,7 +697,7 @@ Usage: llama-stack-client shields [OPTIONS] COMMAND [ARGS]...
661697

662698
**Commands**
663699

664-
* **list**: Show available safety shields on distribution...
700+
* **list**: Show available safety shields on distribution endpoint
665701

666702
* **register**: Register a new safety shield
667703

@@ -717,13 +753,13 @@ Usage: llama-stack-client toolgroups [OPTIONS] COMMAND [ARGS]...
717753

718754
**Commands**
719755

720-
* **get**: Show available llama toolgroups at...
756+
* **get**: Show available llama toolgroups at distribution endpoint
721757

722-
* **list**: Show available llama toolgroups at...
758+
* **list**: Show available llama toolgroups at distribution endpoint
723759

724-
* **register**: Register a new toolgroup at distribution...
760+
* **register**: Register a new toolgroup at distribution endpoint
725761

726-
* **unregister**: Unregister a toolgroup from distribution...
762+
* **unregister**: Unregister a toolgroup from distribution endpoint
727763

728764

729765

@@ -817,7 +853,7 @@ Usage: llama-stack-client vector-dbs [OPTIONS] COMMAND [ARGS]...
817853

818854
**Commands**
819855

820-
* **list**: Show available vector dbs on distribution...
856+
* **list**: Show available vector dbs on distribution endpoint
821857

822858
* **register**: Create a new vector db
823859

scripts/gen_cli_doc.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ def generate_markdown_docs(command, parent=None, level=1):
5656
doc.append("**Commands**\n")
5757
for cmd_name in command.list_commands(ctx):
5858
cmd = command.get_command(ctx, cmd_name)
59-
cmd_help = cmd.get_short_help_str() if cmd else ""
59+
cmd_help = cmd.get_short_help_str(limit=80) if cmd else ""
6060
doc.append(f"* **{cmd_name}**: {cmd_help}\n")
6161

6262
# Add detailed subcommand documentation

0 commit comments

Comments
 (0)