Skip to content

cli_app.cli.commands.completion

cli_app.cli.commands.completion

Shell completion management commands.

install_completion 

install_completion(shell=None)

Install shell completion for the current shell into its profile file.

Source code in src/cli_app/cli/commands/completion.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
@app.command("install")
def install_completion(
    shell: Annotated[
        str | None,
        typer.Option(
            "--shell",
            "-s",
            help="Target shell: bash, zsh, fish, powershell. Auto-detected if omitted.",
        ),
    ] = None,
) -> None:
    """Install shell completion for the current shell into its profile file."""
    cmd = [sys.argv[0], "--install-completion"]
    if shell:
        cmd.append(shell)
    result = subprocess.run(cmd, check=False)  # noqa: S603
    raise typer.Exit(result.returncode)

show_completion 

show_completion(shell=None)

Print the shell completion script to stdout.

Source code in src/cli_app/cli/commands/completion.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
@app.command("show")
def show_completion(
    shell: Annotated[
        str | None,
        typer.Option(
            "--shell",
            "-s",
            help="Target shell: bash, zsh, fish, powershell. Auto-detected if omitted.",
        ),
    ] = None,
) -> None:
    """Print the shell completion script to stdout."""
    cmd = [sys.argv[0], "--show-completion"]
    if shell:
        cmd.append(shell)
    result = subprocess.run(cmd, check=False)  # noqa: S603
    raise typer.Exit(result.returncode)