CLI Reference

If you are interested in a quick guide to getting started with Hipcheck, we recommend checking out the Getting Started guide first! For a more thorough explanation of Hipcheck's Command Line Interface (CLI), please continue with this section!

General Flags

Flags which apply to all Hipcheck subcommands.

hc cache

Inspect and control Hipcheck's local data cache.

hc check

Run analyses against specified targets.

hc ready

Check if Hipcheck is ready to run.

hc schema

Get a JSON schema for Hipcheck's JSON output.

hc scoring

Get a visualization of Hipcheck's scoring tree based on your policy.

hc setup

Complete post-installation setup of Hipcheck.

hc update

Have Hipcheck update itself.

hc explain

Understand any Hipcheck-specific logic.