chore: add subcommands description in help

Signed-off-by: reidliu <[email protected]>
meta-llama · Feb 22, 2025 · e1b7380 · e1b7380
1 parent b890d7a
commit e1b7380
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/llama_stack/cli/llama.py b/llama_stack/cli/llama.py
@@ -20,6 +20,7 @@ def __init__(self):
             prog="llama",
             description="Welcome to the Llama CLI",
             add_help=True,
+            formatter_class=argparse.RawTextHelpFormatter,
         )
 
         # Default command is to print help
@@ -33,12 +34,21 @@ def __init__(self):
         Download.create(subparsers)
         VerifyDownload.create(subparsers)
 
+        self.print_subcommand_description(subparsers)
+
     def parse_args(self) -> argparse.Namespace:
         return self.parser.parse_args()
 
     def run(self, args: argparse.Namespace) -> None:
         args.func(args)
 
+    def print_subcommand_description(self, subparsers: argparse._SubParsersAction):
+        description_text = ""
+        for name, subcommand in subparsers.choices.items():
+            description = subcommand.description
+            description_text += f"  {name:<21} {description}\n"
+        self.parser.epilog = description_text
+
 
 def main():
     parser = LlamaCLIParser()

diff --git a/llama_stack/cli/model/model.py b/llama_stack/cli/model/model.py
@@ -24,6 +24,7 @@ def __init__(self, subparsers: argparse._SubParsersAction):
             "model",
             prog="llama model",
             description="Work with llama models",
+            formatter_class=argparse.RawTextHelpFormatter,
         )
 
         self.parser.set_defaults(func=lambda args: self.parser.print_help())
@@ -37,3 +38,12 @@ def __init__(self, subparsers: argparse._SubParsersAction):
         ModelDescribe.create(subparsers)
         ModelVerifyDownload.create(subparsers)
         ModelRemove.create(subparsers)
+
+        self.print_subcommand_description(subparsers)
+
+    def print_subcommand_description(self, subparsers: argparse._SubParsersAction):
+        description_text = ""
+        for name, subcommand in subparsers.choices.items():
+            description = subcommand.description
+            description_text += f"  {name:<21} {description}\n"
+        self.parser.epilog = description_text
diff --git a/llama_stack/cli/stack/stack.py b/llama_stack/cli/stack/stack.py
@@ -22,6 +22,7 @@ def __init__(self, subparsers: argparse._SubParsersAction):
             "stack",
             prog="llama stack",
             description="Operations for the Llama Stack / Distributions",
+            formatter_class=argparse.RawTextHelpFormatter,
         )
 
         self.parser.add_argument(
@@ -39,3 +40,12 @@ def __init__(self, subparsers: argparse._SubParsersAction):
         StackListApis.create(subparsers)
         StackListProviders.create(subparsers)
         StackRun.create(subparsers)
+
+        self.print_subcommand_description(subparsers)
+
+    def print_subcommand_description(self, subparsers: argparse._SubParsersAction):
+        description_text = ""
+        for name, subcommand in subparsers.choices.items():
+            description = subcommand.description
+            description_text += f"  {name:<21} {description}\n"
+        self.parser.epilog = description_text