Skip to the cargo

hk completion ​

  • How to hail it: hk completion [--install] [--force] <SHELL>
  • Effect: read-only (looks, never touches)

Generate shell completion scripts, so yer shell can finish the bosun's calls for ye.

Cargo it takes ​

  • <SHELL> — The shell to draw up completions for

Flags to fly ​

  • --install — Put the script where this shell looks for it, instead of printing it on deck

    Writes the script file and nothing else: no shell rc file and no PowerShell profile is edited. Where a shell needs a one-time line of its own — zsh's fpath+=, PowerShell's dot-source — it is printed for ye to add by hand.

    Effect: modifies state (it touches, as well as looks)

  • --force — Replace a file at the target path that hk did not write: heave it out and put this script in its place

    Effect: modifies state (it touches, as well as looks)

  • -h --help — Print help, for when ye've lost yer bearings

Tales from the deck ​

Generate a completion script, or install it in the place yer shell looks. hk prints any shell setup instructions that remain for ye.

sh
hk completion bash
hk completion zsh --install
hk completion fish --install

Further charts ​

Getting started: get under way · Troubleshooting: the ship's log · All the bosun's calls

MIT LicenseCopyright © 2026jdx.dev