From 45b380c3f18b80322be9373d0768c24d1eb936b6 Mon Sep 17 00:00:00 2001 From: Simon Willison Date: Mon, 4 Sep 2023 17:08:30 -0700 Subject: [PATCH] Fix broken internal references in help.md --- docs/help.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/docs/help.md b/docs/help.md index a77c22c..6a4b0f1 100644 --- a/docs/help.md +++ b/docs/help.md @@ -27,7 +27,7 @@ def all_help(cli): hyphenated = "-".join(command) if hyphenated: hyphenated = "-" + hyphenated - output.append(f"(help{hyphenated})=") + output.append(f"\n(help{hyphenated})=") output.append("#" * heading_level + " llm " + " ".join(command) + " --help") output.append("```") output.append(result.output.replace("Usage: cli", "Usage: llm").strip()) @@ -35,6 +35,7 @@ def all_help(cli): return "\n".join(output) cog.out(all_help(cli)) ]]] --> + (help)= ## llm --help ``` @@ -74,6 +75,7 @@ Commands: templates Manage stored prompt templates uninstall Uninstall Python packages from the LLM environment ``` + (help-prompt)= ### llm prompt --help ``` @@ -98,6 +100,7 @@ Options: --save TEXT Save prompt with this template name --help Show this message and exit. ``` + (help-keys)= ### llm keys --help ``` @@ -113,6 +116,7 @@ Commands: path Output the path to the keys.json file set Save a key in the keys.json file ``` + (help-keys-list)= #### llm keys list --help ``` @@ -123,6 +127,7 @@ Usage: llm keys list [OPTIONS] Options: --help Show this message and exit. ``` + (help-keys-path)= #### llm keys path --help ``` @@ -133,6 +138,7 @@ Usage: llm keys path [OPTIONS] Options: --help Show this message and exit. ``` + (help-keys-set)= #### llm keys set --help ``` @@ -149,6 +155,7 @@ Options: --value TEXT Value to set --help Show this message and exit. ``` + (help-logs)= ### llm logs --help ``` @@ -166,6 +173,7 @@ Commands: path Output the path to the logs.db file status Show current status of database logging ``` + (help-logs-path)= #### llm logs path --help ``` @@ -176,6 +184,7 @@ Usage: llm logs path [OPTIONS] Options: --help Show this message and exit. ``` + (help-logs-status)= #### llm logs status --help ``` @@ -186,6 +195,7 @@ Usage: llm logs status [OPTIONS] Options: --help Show this message and exit. ``` + (help-logs-on)= #### llm logs on --help ``` @@ -196,6 +206,7 @@ Usage: llm logs on [OPTIONS] Options: --help Show this message and exit. ``` + (help-logs-off)= #### llm logs off --help ``` @@ -206,6 +217,7 @@ Usage: llm logs off [OPTIONS] Options: --help Show this message and exit. ``` + (help-logs-list)= #### llm logs list --help ``` @@ -225,6 +237,7 @@ Options: --json Output logs as JSON --help Show this message and exit. ``` + (help-models)= ### llm models --help ``` @@ -239,6 +252,7 @@ Commands: list* List available models default Show or set the default model ``` + (help-models-list)= #### llm models list --help ``` @@ -250,6 +264,7 @@ Options: --options Show options for each model, if available --help Show this message and exit. ``` + (help-models-default)= #### llm models default --help ``` @@ -260,6 +275,7 @@ Usage: llm models default [OPTIONS] [MODEL] Options: --help Show this message and exit. ``` + (help-templates)= ### llm templates --help ``` @@ -276,6 +292,7 @@ Commands: path Output the path to the templates directory show Show the specified prompt template ``` + (help-templates-list)= #### llm templates list --help ``` @@ -286,6 +303,7 @@ Usage: llm templates list [OPTIONS] Options: --help Show this message and exit. ``` + (help-templates-show)= #### llm templates show --help ``` @@ -296,6 +314,7 @@ Usage: llm templates show [OPTIONS] NAME Options: --help Show this message and exit. ``` + (help-templates-edit)= #### llm templates edit --help ``` @@ -306,6 +325,7 @@ Usage: llm templates edit [OPTIONS] NAME Options: --help Show this message and exit. ``` + (help-templates-path)= #### llm templates path --help ``` @@ -316,6 +336,7 @@ Usage: llm templates path [OPTIONS] Options: --help Show this message and exit. ``` + (help-aliases)= ### llm aliases --help ``` @@ -332,6 +353,7 @@ Commands: remove Remove an alias set Set an alias for a model ``` + (help-aliases-list)= #### llm aliases list --help ``` @@ -343,6 +365,7 @@ Options: --json Output as JSON --help Show this message and exit. ``` + (help-aliases-set)= #### llm aliases set --help ``` @@ -357,6 +380,7 @@ Usage: llm aliases set [OPTIONS] ALIAS MODEL_ID Options: --help Show this message and exit. ``` + (help-aliases-remove)= #### llm aliases remove --help ``` @@ -371,6 +395,7 @@ Usage: llm aliases remove [OPTIONS] ALIAS Options: --help Show this message and exit. ``` + (help-aliases-path)= #### llm aliases path --help ``` @@ -381,6 +406,7 @@ Usage: llm aliases path [OPTIONS] Options: --help Show this message and exit. ``` + (help-plugins)= ### llm plugins --help ``` @@ -391,6 +417,7 @@ Usage: llm plugins [OPTIONS] Options: --help Show this message and exit. ``` + (help-install)= ### llm install --help ``` @@ -406,6 +433,7 @@ Options: --no-cache-dir Disable the cache --help Show this message and exit. ``` + (help-uninstall)= ### llm uninstall --help ``` @@ -417,6 +445,7 @@ Options: -y, --yes Don't ask for confirmation --help Show this message and exit. ``` + (help-embed)= ### llm embed --help ``` @@ -435,6 +464,7 @@ Options: Output format --help Show this message and exit. ``` + (help-embed-multi)= ### llm embed-multi --help ``` @@ -468,6 +498,7 @@ Options: -d, --database FILE --help Show this message and exit. ``` + (help-similar)= ### llm similar --help ``` @@ -490,6 +521,7 @@ Options: -d, --database FILE --help Show this message and exit. ``` + (help-embed-models)= ### llm embed-models --help ``` @@ -504,6 +536,7 @@ Commands: list* List available embedding models default Show or set the default embedding model ``` + (help-embed-models-list)= #### llm embed-models list --help ``` @@ -514,6 +547,7 @@ Usage: llm embed-models list [OPTIONS] Options: --help Show this message and exit. ``` + (help-embed-models-default)= #### llm embed-models default --help ``` @@ -525,6 +559,7 @@ Options: --remove-default Reset to specifying no default model --help Show this message and exit. ``` + (help-embed-db)= ### llm embed-db --help ``` @@ -540,6 +575,7 @@ Commands: delete-collection Delete the specified collection path Output the path to the embeddings database ``` + (help-embed-db-path)= #### llm embed-db path --help ``` @@ -550,6 +586,7 @@ Usage: llm embed-db path [OPTIONS] Options: --help Show this message and exit. ``` + (help-embed-db-collections)= #### llm embed-db collections --help ``` @@ -562,6 +599,7 @@ Options: --json Output as JSON --help Show this message and exit. ``` + (help-embed-db-delete-collection)= #### llm embed-db delete-collection --help ``` @@ -577,6 +615,7 @@ Options: -d, --database FILE Path to embeddings database --help Show this message and exit. ``` + (help-openai)= ### llm openai --help ``` @@ -590,6 +629,7 @@ Options: Commands: models List models available to you from the OpenAI API ``` + (help-openai-models)= #### llm openai models --help ```