Better --help for llm keys get, refs #623

simonw · Nov 11, 2024 · dff53a9 · dff53a9
1 parent 561784d
commit dff53a9
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/docs/help.md b/docs/help.md
@@ -190,6 +190,10 @@ Usage: llm keys get [OPTIONS] NAME
 
   Return the value of a stored key
 
+  Example usage:
+
+      export OPENAI_API_KEY=$(llm keys get openai)
+
 Options:
   --help  Show this message and exit.
 ```

diff --git a/llm/cli.py b/llm/cli.py
@@ -607,7 +607,14 @@ def keys_path_command():
 @keys.command(name="get")
 @click.argument("name")
 def keys_get(name):
-    "Return the value of a stored key"
+    """
+    Return the value of a stored key
+
+    Example usage:
+
+    \b
+        export OPENAI_API_KEY=$(llm keys get openai)
+    """
     path = user_dir() / "keys.json"
     if not path.exists():
         raise click.ClickException("No keys found")