Skip to the cargo

hk init ​

  • How to hail it: hk init [FLAGS]
  • Effect: modifies state (it touches, as well as looks)

Generate a new hk.pkl file for a project: fresh charts for the ship.

Flags to fly ​

  • -f --force — Overwrite an existing hk.pkl file, old charts and all

  • -i --interactive — Interactive mode: pick yer lookouts (linters) and hooks by hand

  • --mise — Generate a mise.toml file with hk configured, for the quartermaster (mise)

    Set HK_MISE=1 as a standing order to make this the default behavior.

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

Tales from the deck ​

Draw up a configuration, then validate it. Install the tools ye selected separately; they don't come aboard on their own.

sh
hk init
hk validate

# Choose linters and hooks interactively
hk init --interactive

Further charts ​

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

MIT LicenseCopyright © 2026jdx.dev