hk validate

• How to hail it: hk validate [--json] [--deny-warnings]
• Effect: read-only (looks, never touches)

Validate the config file: make sure the ship's charts are true.

Fails on charts hk cannot sail. Also hollers warnings for settings that load but likely aren't what was meant: unknown properties (which release builds silently drop), depends that never orders anything, steps without a command, and globs that cannot match.

Flags to fly

• --json — Print the result as a JSON document on stdout
• --deny-warnings — Exit with a non-zero status when the config has warnings
• -h --help — Print help, for when ye've lost yer bearings

Tales from the deck

Evaluate the selected configuration without running its linter commands: the charts are read, and no lookout goes aloft.

hk validate
HK_FILE=./hk.local.pkl hk validate

Further charts

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