docs: update help text

Signed-off-by: reidliu <[email protected]>
meta-llama · Mar 2, 2025 · f71e491 · f71e491
1 parent 52977e5
commit f71e491
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 10 deletions.
diff --git a/docs/source/references/llama_cli_reference/index.md b/docs/source/references/llama_cli_reference/index.md
@@ -38,15 +38,20 @@ llama --help
 ```
 
 ```
-usage: llama [-h] {download,model,stack} ...
+usage: llama [-h] {model,stack,download,verify-download} ...
 
 Welcome to the Llama CLI
 
 options:
   -h, --help            show this help message and exit
 
 subcommands:
-  {download,model,stack}
+  {model,stack,download,verify-download}
+
+  model                 Work with llama models
+  stack                 Operations for the Llama Stack / Distributions
+  download              Download a model from llama.meta.com or Hugging Face Hub
+  verify-download       Verify integrity of downloaded model files
 ```
 
 ## Downloading models
@@ -212,6 +217,13 @@ options:
 
 model_subcommands:
   {download,list,prompt-format,describe,verify-download,remove}
+
+  download              Download a model from llama.meta.com or Hugging Face Hub
+  list                  Show available llama models
+  prompt-format         Show llama model message formats
+  describe              Show details about a llama model
+  verify-download       Verify the downloaded checkpoints' checksums for models downloaded from Meta
+  remove                Remove the downloaded llama model
 ```
 
 ### Describe

diff --git a/docs/source/references/llama_stack_client_cli_reference.md b/docs/source/references/llama_stack_client_cli_reference.md
@@ -6,17 +6,33 @@ The `llama-stack-client` CLI allows you to query information about the distribut
 
 ### `llama-stack-client`
 ```bash
-llama-stack-client -h
+llama-stack-client --help
 
-usage: llama-stack-client [-h] {models,memory_banks,shields} ...
+Usage: llama-stack-client [OPTIONS] COMMAND [ARGS]...
 
-Welcome to the LlamaStackClient CLI
+  Welcome to the LlamaStackClient CLI
 
-options:
-  -h, --help            show this help message and exit
-
-subcommands:
-  {models,memory_banks,shields}
+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.
 ```
 
 ### `llama-stack-client configure`