phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-08-13 05:17:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs: Remove $ from client CLI ref to add valid copy and paste ability

Browse source
This commit is contained in:
Kelly Brown 2025-02-25 16:41:44 -05:00
parent 0885f959f1
commit deae02f313
1 changed files with 22 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

44
docs/source/references/llama_stack_client_cli_reference.md
View file

@ -6,7 +6,7 @@ The `llama-stack-client` CLI allows you to query information about the distribut
### `llama-stack-client` ### `llama-stack-client`
```bash ```bash
$ llama-stack-client -h llama-stack-client -h
usage: llama-stack-client [-h] {models,memory_banks,shields} ... usage: llama-stack-client [-h] {models,memory_banks,shields} ...
@ -21,7 +21,7 @@ subcommands:
### `llama-stack-client configure` ### `llama-stack-client configure`
```bash ```bash
$ llama-stack-client configure llama-stack-client configure
> Enter the host name of the Llama Stack distribution server: localhost > Enter the host name of the Llama Stack distribution server: localhost
> Enter the port number of the Llama Stack distribution server: 8321 > Enter the port number of the Llama Stack distribution server: 8321
Done! You can now use the Llama Stack Client CLI with endpoint http://localhost:8321 Done! You can now use the Llama Stack Client CLI with endpoint http://localhost:8321
@ -29,7 +29,7 @@ Done! You can now use the Llama Stack Client CLI with endpoint http://localhost:
### `llama-stack-client providers list` ### `llama-stack-client providers list`
```bash ```bash
$ llama-stack-client providers list llama-stack-client providers list
``` ```
``` ```
+-----------+----------------+-----------------+ +-----------+----------------+-----------------+
@ -55,7 +55,7 @@ $ llama-stack-client providers list
### `llama-stack-client models list` ### `llama-stack-client models list`
```bash ```bash
$ llama-stack-client models list llama-stack-client models list
``` ```
``` ```
+----------------------+----------------------+---------------+----------------------------------------------------------+ +----------------------+----------------------+---------------+----------------------------------------------------------+
@ -67,7 +67,7 @@ $ llama-stack-client models list
### `llama-stack-client models get` ### `llama-stack-client models get`
```bash ```bash
$ llama-stack-client models get Llama3.1-8B-Instruct llama-stack-client models get Llama3.1-8B-Instruct
``` ```
``` ```
@ -80,7 +80,7 @@ $ llama-stack-client models get Llama3.1-8B-Instruct
```bash ```bash
$ llama-stack-client models get Random-Model llama-stack-client models get Random-Model
Model RandomModel is not found at distribution endpoint host:port. Please ensure endpoint is serving specified model. Model RandomModel is not found at distribution endpoint host:port. Please ensure endpoint is serving specified model.
``` ```
@ -88,26 +88,26 @@ Model RandomModel is not found at distribution endpoint host:port. Please ensure
### `llama-stack-client models register` ### `llama-stack-client models register`
```bash ```bash
$ llama-stack-client models register <model_id> [--provider-id <provider_id>] [--provider-model-id <provider_model_id>] [--metadata <metadata>] llama-stack-client models register <model_id> [--provider-id <provider_id>] [--provider-model-id <provider_model_id>] [--metadata <metadata>]
``` ```
### `llama-stack-client models update` ### `llama-stack-client models update`
```bash ```bash
$ llama-stack-client models update <model_id> [--provider-id <provider_id>] [--provider-model-id <provider_model_id>] [--metadata <metadata>] llama-stack-client models update <model_id> [--provider-id <provider_id>] [--provider-model-id <provider_model_id>] [--metadata <metadata>]
``` ```
### `llama-stack-client models delete` ### `llama-stack-client models delete`
```bash ```bash
$ llama-stack-client models delete <model_id> llama-stack-client models delete <model_id>
``` ```
## Vector DB Management ## Vector DB Management
### `llama-stack-client vector_dbs list` ### `llama-stack-client vector_dbs list`
```bash ```bash
$ llama-stack-client vector_dbs list llama-stack-client vector_dbs list
``` ```
``` ```
+--------------+----------------+---------------------+---------------+------------------------+ +--------------+----------------+---------------------+---------------+------------------------+
@ -120,7 +120,7 @@ $ llama-stack-client vector_dbs list
### `llama-stack-client vector_dbs register` ### `llama-stack-client vector_dbs register`
```bash ```bash
$ llama-stack-client vector_dbs register <vector-db-id> [--provider-id <provider-id>] [--provider-vector-db-id <provider-vector-db-id>] [--embedding-model <embedding-model>] [--embedding-dimension <embedding-dimension>] llama-stack-client vector_dbs register <vector-db-id> [--provider-id <provider-id>] [--provider-vector-db-id <provider-vector-db-id>] [--embedding-model <embedding-model>] [--embedding-dimension <embedding-dimension>]
``` ```
Options: Options:
@ -131,13 +131,13 @@ Options:
### `llama-stack-client vector_dbs unregister` ### `llama-stack-client vector_dbs unregister`
```bash ```bash
$ llama-stack-client vector_dbs unregister <vector-db-id> llama-stack-client vector_dbs unregister <vector-db-id>
``` ```
## Shield Management ## Shield Management
### `llama-stack-client shields list` ### `llama-stack-client shields list`
```bash ```bash
$ llama-stack-client shields list llama-stack-client shields list
``` ```
``` ```
@ -150,7 +150,7 @@ $ llama-stack-client shields list
### `llama-stack-client shields register` ### `llama-stack-client shields register`
```bash ```bash
$ llama-stack-client shields register --shield-id <shield-id> [--provider-id <provider-id>] [--provider-shield-id <provider-shield-id>] [--params <params>] llama-stack-client shields register --shield-id <shield-id> [--provider-id <provider-id>] [--provider-shield-id <provider-shield-id>] [--params <params>]
``` ```
Options: Options:
@ -163,12 +163,12 @@ Options:
### `llama-stack-client benchmarks list` ### `llama-stack-client benchmarks list`
```bash ```bash
$ llama-stack-client benchmarks list llama-stack-client benchmarks list
``` ```
### `llama-stack-client benchmarks register` ### `llama-stack-client benchmarks register`
```bash ```bash
$ llama-stack-client benchmarks register --eval-task-id <eval-task-id> --dataset-id <dataset-id> --scoring-functions <function1> [<function2> ...] [--provider-id <provider-id>] [--provider-eval-task-id <provider-eval-task-id>] [--metadata <metadata>] llama-stack-client benchmarks register --eval-task-id <eval-task-id> --dataset-id <dataset-id> --scoring-functions <function1> [<function2> ...] [--provider-id <provider-id>] [--provider-eval-task-id <provider-eval-task-id>] [--metadata <metadata>]
``` ```
Options: Options:
@ -182,7 +182,7 @@ Options:
## Eval execution ## Eval execution
### `llama-stack-client eval run-benchmark` ### `llama-stack-client eval run-benchmark`
```bash ```bash
$ llama-stack-client eval run-benchmark <eval-task-id1> [<eval-task-id2> ...] --eval-task-config <config-file> --output-dir <output-dir> [--num-examples <num>] [--visualize] llama-stack-client eval run-benchmark <eval-task-id1> [<eval-task-id2> ...] --eval-task-config <config-file> --output-dir <output-dir> [--num-examples <num>] [--visualize]
``` ```
Options: Options:
@ -207,7 +207,7 @@ Example benchmark_config.json:
### `llama-stack-client eval run-scoring` ### `llama-stack-client eval run-scoring`
```bash ```bash
$ llama-stack-client eval run-scoring <eval-task-id> --eval-task-config <config-file> --output-dir <output-dir> [--num-examples <num>] [--visualize] llama-stack-client eval run-scoring <eval-task-id> --eval-task-config <config-file> --output-dir <output-dir> [--num-examples <num>] [--visualize]
``` ```
Options: Options:
@ -220,7 +220,7 @@ Options:
### `llama-stack-client toolgroups list` ### `llama-stack-client toolgroups list`
```bash ```bash
$ llama-stack-client toolgroups list llama-stack-client toolgroups list
``` ```
``` ```
+---------------------------+------------------+------+---------------+ +---------------------------+------------------+------+---------------+
@ -236,14 +236,14 @@ $ llama-stack-client toolgroups list
### `llama-stack-client toolgroups get` ### `llama-stack-client toolgroups get`
```bash ```bash
$ llama-stack-client toolgroups get <toolgroup_id> llama-stack-client toolgroups get <toolgroup_id>
``` ```
Shows detailed information about a specific toolgroup. If the toolgroup is not found, displays an error message. Shows detailed information about a specific toolgroup. If the toolgroup is not found, displays an error message.
### `llama-stack-client toolgroups register` ### `llama-stack-client toolgroups register`
```bash ```bash
$ llama-stack-client toolgroups register <toolgroup_id> [--provider-id <provider-id>] [--provider-toolgroup-id <provider-toolgroup-id>] [--mcp-config <mcp-config>] [--args <args>] llama-stack-client toolgroups register <toolgroup_id> [--provider-id <provider-id>] [--provider-toolgroup-id <provider-toolgroup-id>] [--mcp-config <mcp-config>] [--args <args>]
``` ```
Options: Options:
@ -254,5 +254,5 @@ Options:
### `llama-stack-client toolgroups unregister` ### `llama-stack-client toolgroups unregister`
```bash ```bash
$ llama-stack-client toolgroups unregister <toolgroup_id> llama-stack-client toolgroups unregister <toolgroup_id>
``` ```