Skip to main content

atmos.completion

The atmos.completion function runs atmos completion through the current Atmos executable. It generates the completion script for Bash, Zsh, Fish, or PowerShell.

Usage​

atmos.completion(
    *positionals,
    flags = {},
    args = [],
    working_directory = ...,
    env = ...,
    output = "stream",
    check = True,
)

Subcommands​

Pass the shell name as the positional argument. The call atmos.completion("zsh") runs atmos completion zsh.

SubcommandPurpose
bashGenerate the completion script for Bash.
zshGenerate the completion script for Zsh.
fishGenerate the completion script for Fish.
powershellGenerate the completion script for PowerShell.

The subcommands register only the --help flag. See the atmos completion command reference for how to load the script into each shell.

note

The script is meant to be loaded by an interactive shell, so calling atmos.completion from a script is useful only when the automation produces the script for another purpose, such as packaging it into an installer or an image. Use output = "capture" to receive the script in stdout instead of printing it.

Arguments​

*positionals

(Optional) Strings placed on the command line right after completion, in order. Pass the shell name: "bash", "zsh", "fish", or "powershell". Every value must be a string.

flags

(Optional) A dictionary of command-line options; see flag translation. A bare key such as "help" becomes --help.

args
(Optional) A list or tuple of strings appended after the flags.
working_directory, env, output, check

(Optional) See atmos.run for process options and defaults.

Options other than the positionals are keyword-only.

Returns​

A result with stdout, stderr, and exit_code. See atmos.run for output and error behavior.

Examples​

Capture the Zsh completion script​

result = atmos.completion("zsh", output = "capture")
print(result.stdout.splitlines()[0])

The first line of the Zsh script is #compdef atmos.

Generate every script​

def generate_all():
    scripts = {}
    for shell in ["bash", "zsh", "fish", "powershell"]:
        scripts[shell] = atmos.completion(shell, output = "capture").stdout
    return scripts

scripts = generate_all()
for shell, script in scripts.items():
    print(shell, len(script.splitlines()), "lines")

Related​