hk run

• How to hail it: hk run [FLAGS] [FILES]… <SUBCOMMAND>
• Also answers to: r

Run a hook: sound the bosun's pipe for it by name.

Cargo it takes

• [FILES]… — Run on specific files: just the cargo ye name

Flags to fly

• -a --all — Select all tracked and eligible untracked files, the whole of the cargo, then apply step filters

• -c --check — Run the check command instead of the fix command: inspect the cargo, don't mend it

• -e --exclude <EXCLUDE> — Exclude files that otherwise would have been selected; that cargo stays out of the run

• -f --fix — Run fix commands instead of check commands for this call only: mend the canvas

• -g --glob <GLOB> — Run on the cargo that matches these glob patterns

• -J --json — Output the passage plan as JSON when combined with --plan or --why

• -P --plan — Print the passage plan instead of running the hook

• -S --step <STEP> — Run only specific step(s): call just the hands ye name

• -W --why [STEP] — Show detailed reasons for inclusion/exclusion: why each hand was mustered or left ashore. Pass a step name to focus on one step, or leave the value off to show reasons for all steps. Implies --plan.

• --fail-fast — Abort on the first failure: the first squall ends the run

• --files0-from <PATH> — Read the exact file list, the cargo manifest, from a NUL-delimited file, or from stdin with - (except hooks that reserve stdin)

• --format <FORMAT> — Select human or machine-readable execution output: for a sailor's eyes, or for machines to read

  Choose from: human, json, jsonl

• --from-ref <FROM_REF> — Select files changed since this reference; optionally pair it with --to-ref

• --junit-xml <PATH> — Write each step's results as a JUnit XML report

• --no-fail-fast — Continue on failures, sailing on through every squall (opposite of --fail-fast)

• --no-stage — Disable auto-staging of fixed files: mended cargo stays on the dock, unstaged

• --pr — Run only on the cargo changed in the current PR or branch (a shortcut for --from-ref DEFAULT_BRANCH --to-ref HEAD)

• --safe — Reject commands with unknown or destructive effects before anything runs

• --sarif <PATH> — Write normalized diagnostics as SARIF: what the lookouts sang out

• --skip-step <STEP> — Skip specific step(s): those hands sit this one out

• --stage — Enable auto-staging of fixed files: mended cargo is loaded aboard

• --staged — Run on staged files only, without stashing unstaged changes: just the cargo loaded aboard, with nothing stowed in the hold

• --stash <STASH> — Stash method to use for git hooks: how the unstaged cargo is stowed in the hold

  Choose from: git, patch-file, none

• --stats — Display statistics about the files matching each step

• --to-ref <TO_REF> — The end reference for the comparison with --from-ref

• --unstaged — Run on unstaged and untracked files only (excludes staged files), without stashing. Useful for linting files a clockwork hand (a coding agent) just changed.

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

Lesser calls

• hk run commit-msg [FLAGS] <COMMIT_MSG_FILE> [FILES]…
• hk run post-checkout [FLAGS] <ARGS>…
• hk run post-commit [FLAGS] [FILES]…
• hk run post-merge [FLAGS] <IS_SQUASH> [FILES]…
• hk run post-rewrite [FLAGS] <COMMAND> [FILES]…
• hk run pre-commit [FLAGS] [FILES]…
• hk run pre-push [FLAGS] [ARGS]…
• hk run pre-rebase [FLAGS] <ARGS>…
• hk run prepare-commit-msg [FLAGS] <ARGS>…

Tales from the deck

Sound a configured hook by name. A passage plan uses the hook's settings without running any of its steps.

hk run pre-commit --plan
hk run pre-commit

# A custom hook defined in hk.pkl
hk run my-hook

Further charts

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