Skip to content

CLI Reference

Terminal window
harnix scan [path]
  • path is optional and defaults to ..
  • scan is the current command.

Include inline rationale per check in terminal output.

Terminal window
harnix scan . --verbose

Write report files to a custom output directory.

Terminal window
harnix scan . --output ./reports/harnix

Also supported:

Terminal window
harnix scan . --output=./reports/harnix

Skip one or more checks.

Terminal window
harnix scan . --skip agents-md,ci-pipeline
harnix scan . --skip agents-md --skip ci-pipeline

Run only the specified checks.

Terminal window
harnix scan . --only agents-md
harnix scan . --only agents-md,documentation

--skip and --only are mutually exclusive.

Override repository type detection.

Terminal window
harnix scan . --type software
harnix scan . --type non-software
Terminal window
harnix --help