Skip to content

Add shell completion for models, templates and option names #952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add shell completion for models, templates and option names #952

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dc90712
Add shell autocomplete for models
yorickvP Apr 24, 2025
a30cf70
Add shell completion for embedding models
yorickvP Apr 24, 2025
032e063
Add shell completion for templates
yorickvP Apr 24, 2025
8e30453
Add shell autocompletion for templates everywhere
yorickvP Apr 25, 2025
eb790e6
Add shell completion for option names
yorickvP Apr 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 46 additions & 8 deletions llm/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,10 +289,44 @@ def cli():
"""


def complete_model(ctx: click.Context, param: click.Parameter, incomplete: str):
from click.shell_completion import CompletionItem

return [CompletionItem(alias) for alias in get_model_aliases().keys() if alias.startswith(incomplete)]

def complete_embedding_model(ctx: click.Context, param: click.Parameter, incomplete: str):
from click.shell_completion import CompletionItem

return [CompletionItem(alias) for alias in get_embedding_model_aliases().keys() if alias.startswith(incomplete)]

def complete_option(ctx: click.Context, param: click.Parameter, incomplete):
from click.shell_completion import CompletionItem

# This function is actually hit for the option 'value' as well.
# But there's no way to tell without patching click.

try:
model_id = ctx.params["model_id"]
model = get_model(model_id or get_default_model())
except (AttributeError, UnknownModelError):
return []
options = model.Options.model_json_schema()["properties"].keys()
return [CompletionItem(option) for option in options if option.startswith(incomplete)]

class TemplateType(click.ParamType):
name = "template"

def shell_complete(self, ctx, param, incomplete):
from click.shell_completion import CompletionItem

path = template_dir()
return [CompletionItem(file.stem) for file in path.glob(incomplete + "*.yaml")]


@cli.command(name="prompt")
@click.argument("prompt", required=False)
@click.option("-s", "--system", help="System prompt to use")
@click.option("model_id", "-m", "--model", help="Model to use", envvar="LLM_MODEL")
@click.option("model_id", "-m", "--model", help="Model to use", envvar="LLM_MODEL", shell_complete=complete_model)
@click.option(
"-d",
"--database",
Expand Down Expand Up @@ -330,6 +364,7 @@ def cli():
type=(str, str),
multiple=True,
help="key/value options for the model",
shell_complete=complete_option,
)
@schema_option
@click.option(
Expand All @@ -350,7 +385,7 @@ def cli():
multiple=True,
help="Fragment to add to system prompt",
)
@click.option("-t", "--template", help="Template to use")
@click.option("-t", "--template", help="Template to use", type=TemplateType())
@click.option(
"-p",
"--param",
Expand Down Expand Up @@ -783,7 +818,7 @@ async def inner():

@cli.command()
@click.option("-s", "--system", help="System prompt to use")
@click.option("model_id", "-m", "--model", help="Model to use", envvar="LLM_MODEL")
@click.option("model_id", "-m", "--model", help="Model to use", envvar="LLM_MODEL", shell_complete=complete_model)
@click.option(
"_continue",
"-c",
Expand All @@ -798,7 +833,7 @@ async def inner():
"--conversation",
help="Continue the conversation with the given ID.",
)
@click.option("-t", "--template", help="Template to use")
@click.option("-t", "--template", help="Template to use", type=TemplateType())
@click.option(
"-p",
"--param",
Expand All @@ -813,6 +848,7 @@ async def inner():
type=(str, str),
multiple=True,
help="key/value options for the model",
shell_complete=complete_option,
)
@click.option("--no-stream", is_flag=True, help="Do not stream output")
@click.option("--key", help="API key to use")
Expand Down Expand Up @@ -1843,7 +1879,7 @@ def templates_list():


@templates.command(name="show")
@click.argument("name")
@click.argument("name", type=TemplateType())
def templates_show(name):
"Show the specified prompt template"
template = load_template(name)
Expand All @@ -1857,7 +1893,7 @@ def templates_show(name):


@templates.command(name="edit")
@click.argument("name")
@click.argument("name", type=TemplateType())
def templates_edit(name):
"Edit the specified prompt template using the default $EDITOR"
# First ensure it exists
Expand Down Expand Up @@ -2373,7 +2409,8 @@ def uninstall(packages, yes):
help="File to embed",
)
@click.option(
"-m", "--model", help="Embedding model to use", envvar="LLM_EMBEDDING_MODEL"
"-m", "--model", help="Embedding model to use", envvar="LLM_EMBEDDING_MODEL",
shell_complete=complete_embedding_model
)
@click.option("--store", is_flag=True, help="Store the text itself in the database")
@click.option(
Expand Down Expand Up @@ -2517,7 +2554,8 @@ def get_db():
)
@click.option("--prefix", help="Prefix to add to the IDs", default="")
@click.option(
"-m", "--model", help="Embedding model to use", envvar="LLM_EMBEDDING_MODEL"
"-m", "--model", help="Embedding model to use", envvar="LLM_EMBEDDING_MODEL",
shell_complete=complete_embedding_model
)
@click.option(
"--prepend",
Expand Down