HEDDLE

CLI reference

heddle shell completion

Shipped
heddle shell completion [OPTIONS] <SHELL>

Generate a shell completion script on stdout. Lives under heddle shell alongside the prompt and auto-cd helpers — there is no top-level heddle completion.

Output text (default)

Completion scripts are generated from the same CLI definition the binary parses with, so they cannot drift from what is actually implemented.

heddle shell also carries shell init , which installs the hook that makes heddle thread cd and heddle thread switch --print-cd-path actually change your directory, and shell prompt, which renders the status fragment for a prompt. All three are text-only: they emit shell code, so --output json does not apply.

The set of shells the argument accepts is not enumerated in the command catalog, so this page does not claim one. Run heddle shell completion --help for the list your build supports.

Not to be confused with heddle complete, which is a hidden internal completion-candidate helper. Do not call it.

Arguments

<SHELL> string required
Shell to generate completion for.

Examples

Write a completion script

bash$ heddle shell completion zsh > /usr/local/share/zsh/site-functions/_heddle

See also