Command Line Interface

Maven Central Version

For detailed configuration and usage, see the cli docs.

Simple Demo

TODO: Add gif

Help

sourcehawk help

Validate Config

Validate configuration file

Basic Usage

sourcehawk validate-config
info

This assumes that you are in the repository directory and the configuration file is named sourcehawk.yml

Use Standard Input

cat Sourcehawk | sourcehawk validate-config -

Absolute Path

sourcehawk validate-config /path/to/config.yml

Scan

Perform scans

Basic Usage

sourcehawk scan
info

This assumes that you are in the repository directory and the configuration file is named sourcehawk.yml

Custom Configuration File

sourcehawk scan -c Sourcehawk

Absolute Repository Location

sourcehawk scan /path/to/repo

Change Verbosity of Output

LOW

sourcehawk scan -v LOW

Change Output Format

JSON

sourcehawk scan -f JSON

Markdown

sourcehawk scan -f MARKDOWN
Edit this page