hk

Usage: hk [FLAGS] <SUBCOMMAND>

Version: 1.18.3

• Usage: hk [FLAGS] <SUBCOMMAND>

Global Flags

--hkrc <PATH>

Path to user configuration file

-j --jobs <JOBS>

Number of jobs to run in parallel

-p --profile… <PROFILE>

Profiles to enable/disable prefix with ! to disable e.g. --profile slow --profile !fast

-s --slow

Shorthand for --profile=slow

-v --verbose…

Enables verbose output

-n --no-progress

Disables progress output

-q --quiet

Suppresses output

--silent

Suppresses all output

--trace

Enable tracing spans and performance diagnostics

--json

Output in JSON format

Subcommands

• hk builtins
• hk cache clear
• hk check [FLAGS] [FILES]…
• hk completion <SHELL>
• hk config <SUBCOMMAND>
• hk config dump [--format <FORMAT>]
• hk config explain <KEY>
• hk config get <KEY>
• hk config sources
• hk fix [FLAGS] [FILES]…
• hk init [-f --force] [--mise]
• hk install [--mise]
• hk migrate <SUBCOMMAND>
• hk migrate pre-commit [FLAGS]
• hk run [FLAGS] [FILES]… <SUBCOMMAND>
• hk run commit-msg [FLAGS] <COMMIT_MSG_FILE> [FILES]…
• hk run pre-commit [FLAGS] [FILES]…
• hk run pre-push [FLAGS] [ARGS]…
• hk run prepare-commit-msg [FLAGS] <ARGS>…
• hk test [FLAGS]
• hk uninstall
• hk util <SUBCOMMAND>
• hk util check-added-large-files [--maxkb <MAXKB>] <FILES>…
• hk util check-byte-order-marker <FILES>…
• hk util check-case-conflict <FILES>…
• hk util check-executables-have-shebangs <FILES>…
• hk util check-merge-conflict [--assume-in-merge] <FILES>…
• hk util check-symlinks <FILES>…
• hk util detect-private-key <FILES>…
• hk util end-of-file-fixer [-f --fix] <FILES>…
• hk util fix-byte-order-marker <FILES>…
• hk util fix-smart-quotes <FILES>…
• hk util mixed-line-ending [-f --fix] <FILES>…
• hk util no-commit-to-branch [--branch… <BRANCH>]
• hk util python-check-ast <FILES>…
• hk util python-debug-statements <FILES>…
• hk util trailing-whitespace [-f --fix] <FILES>…
• hk validate
• hk version