Shell Completion

---

Shell Completion

Firestarter ships shell completion via Click's built-in _FIRESTARTER_COMPLETE=<shell>_source firestarter mechanism. No external dependency is needed — Click is already a Firestarter runtime dependency, so completion is available the moment Firestarter is installed.

Completion is opt-in: each shell needs the activation line added to its rc / profile file. Pick the section for your shell below.

Bash

Add the following line to your ~/.bashrc:

eval "$(_FIRESTARTER_COMPLETE=bash_source firestarter)"

Then reload your shell, or source ~/.bashrc.

Zsh

Add the following line to your ~/.zshrc:

eval "$(_FIRESTARTER_COMPLETE=zsh_source firestarter)"

Then restart your terminal session.

Fish

Save Click's completion script to fish's per-command completions directory:

_FIRESTARTER_COMPLETE=fish_source firestarter | source

For persistence across shell sessions, write the script to ~/.config/fish/completions/firestarter.fish:

mkdir -p ~/.config/fish/completions
_FIRESTARTER_COMPLETE=fish_source firestarter > ~/.config/fish/completions/firestarter.fish

PowerShell

Add the following line to your PowerShell $PROFILE (typically ~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1):

_FIRESTARTER_COMPLETE=powershell_source firestarter | Out-String | Invoke-Expression

Restart PowerShell.

pipx Installations

The procedure above is the same whether you install Firestarter via pip or pipx. The pipx-installed executable is isolated in its own environment, so make sure the command name (firestarter) matches what you reference in your shell configuration. Verify the installation with:

pipx list

Migrating from a previous Firestarter

Older Firestarter versions used a different completion library, activated via eval "$(register-python-argcomplete firestarter)". That line no longer works — replace it with the matching _FIRESTARTER_COMPLETE=<shell>_source firestarter line for your shell from the sections above.

For more details on Click's completion implementation, see the Click shell completion documentation.

---

Relocated from firestarter_app/autocomplete.md in firestarter_app at d56424e1979edf7245cffb9ec3111c0469f5b23f. Moved intact and not edited since; not re-verified against the code.