Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 57 additions & 21 deletions docs/cli_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,12 @@ Usage: llama-stack-client datasets [OPTIONS] COMMAND [ARGS]...

**Commands**

* **list**: Show available datasets on distribution...
* **list**: Show available datasets on distribution endpoint

* **register**: Create a new dataset

* **unregister**: Remove a dataset



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

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

* **--provider-id**: Provider ID for the dataset

* **--provider-dataset-id**: Provider's dataset ID
* **--purpose**: Purpose of the dataset

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

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

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

* **--schema**: JSON schema of the dataset


### unregister

Remove a dataset

```
Usage: llama-stack-client datasets unregister [OPTIONS] DATASET_ID
```

**Options**

* **-h, --help**: Show this message and exit. [default: False]

**Arguments**

* **DATASET_ID**



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

**Commands**

* **list**: Show available eval tasks on distribution...
* **list**: Show available eval tasks on distribution endpoint

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

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

**Commands**

* **chat-completion**: Show available inference chat completion...
* **chat-completion**: Show available inference chat completion endpoints on distribution endpoint



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

**Commands**

* **version**: Show available providers on distribution...
* **version**: Show available providers on distribution endpoint



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

**Commands**

* **get**: Show available llama models at distribution...
* **get**: Show details of a specific model at the distribution endpoint

* **list**: Show available llama models at distribution...
* **list**: Show available llama models at distribution endpoint

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

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

### get

Show available llama models at distribution endpoint
Show details of a specific model at the distribution endpoint

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

**Commands**

* **artifacts**: Get the training artifacts of a specific post...
* **artifacts**: Get the training artifacts of a specific post training job

* **cancel**: Cancel the training job

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

* **status**: Show the status of a specific post training...
* **status**: Show the status of a specific post training job

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

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

**Commands**

* **list**: Show available providers on distribution...
* **inspect**: Show available providers on distribution endpoint

* **list**: Show available providers on distribution endpoint



### inspect

Show available providers on distribution endpoint

```
Usage: llama-stack-client providers inspect [OPTIONS] PROVIDER_ID
```

**Options**

* **--help**: Show this message and exit. [default: False]

**Arguments**

* **PROVIDER_ID**



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

**Commands**

* **list**: Show available scoring functions on...
* **list**: Show available scoring functions on distribution endpoint

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

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

**Commands**

* **list**: Show available safety shields on distribution...
* **list**: Show available safety shields on distribution endpoint

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

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

**Commands**

* **get**: Show available llama toolgroups at...
* **get**: Show available llama toolgroups at distribution endpoint

* **list**: Show available llama toolgroups at...
* **list**: Show available llama toolgroups at distribution endpoint

* **register**: Register a new toolgroup at distribution...
* **register**: Register a new toolgroup at distribution endpoint

* **unregister**: Unregister a toolgroup from distribution...
* **unregister**: Unregister a toolgroup from distribution endpoint



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

**Commands**

* **list**: Show available vector dbs on distribution...
* **list**: Show available vector dbs on distribution endpoint

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

Expand Down
2 changes: 1 addition & 1 deletion scripts/gen_cli_doc.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ def generate_markdown_docs(command, parent=None, level=1):
doc.append("**Commands**\n")
for cmd_name in command.list_commands(ctx):
cmd = command.get_command(ctx, cmd_name)
cmd_help = cmd.get_short_help_str() if cmd else ""
cmd_help = cmd.get_short_help_str(limit=80) if cmd else ""
doc.append(f"* **{cmd_name}**: {cmd_help}\n")

# Add detailed subcommand documentation
Expand Down
Loading