hk

A fast and extensible git hook manager

Runs as hk|macOS, Linux, Windows|hk.jdx.dev

Command form

ai-draft · 3 tasks · 11 fields

Run the check hook over a repository with hk check. Other hk commands, hook subcommands and output options are left out.

Opens the form; the finished command lands at your prompt, unrun

Run in Otty

otty gui hk

`hk check`

Check files

Run each step's check command on selected files.

Check filesExample values, fixed in this page — nothing here reaches a terminal

Basic

All files*

--all

Advanced

Only step

string

Skip step

string

TasksEach one presets the form for one job

Check the whole repository

allstepskip_step

Check staged files

stagedstepskip_step

Check this branch

prstepskip_step

ParametersOnly these flags are editable in the form

Files

path · positional 0 · repeatable

All files

boolean

--all-a

Fix instead of check

Runs fix commands, which can modify files.
boolean

--fix-f

Staged files only

boolean

--staged

Files changed in this branch

boolean

--pr

Print plan only

boolean

--plan-P

Only step

string · repeatable

--step-S

Skip step

string · repeatable

--skip-step

Glob

string · repeatable

--glob-g

From ref

string

--from-ref

To ref

string

--to-ref

SourcesEvery flag above is checked against these

docs

- **`[FILES]…`** — Run on specific files - **`-a --all`** — Select all tracked and eligible untracked files, then apply step filters - **`-f --fix`** — Run fix commands instead of check commands for this invocation - **`-g --glob <GLOB>`** — Run on files that match these glob patterns - **`-S --step <STEP>`** — Run only specific step(s) - **`-P --plan`** — P…

manualv2.9.0

raw.githubusercontent.com

Before it fills your prompt, Otty checks the installed hk against its version. A form that does not match your version is not offered.