hk util

• How to hail it: hk util <SUBCOMMAND>
• Effect: read-only for this call itself, which only lists the lesser calls. Some of them mend the cargo in place. format-diff and sarif-diff run whatever command ye hand them, so they do whatever that command does; the others' pages each give their own effect.

Utility commands for file operations: the ship's tool chest for working the cargo.

Flags to fly

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

Lesser calls

• hk util check-added-large-files [--maxkb <MAXKB>] <FILES>…
• hk util check-byte-order-marker [-d --diff] <FILES>…
• hk util check-case-conflict <FILES>…
• hk util check-conventional-commit [--allowed-types <ALLOWED_TYPES>] <COMMIT_MSG_FILE>
• hk util check-executables-have-shebangs <FILES>…
• hk util check-merge-conflict [--assume-in-merge] <FILES>…
• hk util check-shebang-scripts-are-executable <FILES>…
• hk util check-symlinks <FILES>…
• hk util destroyed-symlinks [FILES]…
• hk util detect-private-key <FILES>…
• hk util end-of-file-fixer [-d --diff] [-f --fix] <FILES>…
• hk util fix-byte-order-marker <FILES>…
• hk util fix-smart-quotes [--check] [-d --diff] <FILES>…
• hk util forbid-submodules [PATHS]…
• hk util format-diff [--no-stdin] <FILES>… <-- COMMAND>…
• hk util mixed-line-ending [-d --diff] [-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 sarif-diff [--findings-exit-code <CODE>] <-- COMMAND>…
• hk util trailing-whitespace [-d --diff] [-f --fix] <FILES>…

Tales from the deck

Each utility works straight on the arguments ye hand it. Several also sail ready-rigged as builtins, part of the standing crew that comes with the ship.

hk util trailing-whitespace README.md
hk util end-of-file-fixer README.md

Further charts

Built-in linters and utilities: the standing crew · Troubleshooting: the ship's log · All the bosun's calls