List of options

Index

• checkstyle --help

• checkstyle --version

• checkstyle --config

• checkstyle --runtime-version

• checkstyle --debug

• checkstyle --output

• checkstyle --format

Description

-h, --help

show a description that how to use checkstyle.

Command-line example:

$ checkstyle -h
$ checkstyle --help

-V, --version

show program’s version number and exit.

Command-line example:

$ checkstyle -V
$ checkstyle --version

-c, --config

set configuration file of checkstyle.

• default: google

• The configuration is specified using the path or keyword(sun and google).

Command-line example:

$ checkstyle -c sun [files...]
$ checkstyle --config path/to/config/file [files...]

--runtime-version

set runtime version of checkstyle.

• default: ‘latest’

Command-line example:

$ checkstyle --runtime-version 10.9.2 [files...]

-d, --debug

print debug logging of checkstyle.

Command-line example:

$ checkstyle -d [files...]
$ checkstyle --debug [files...]

-o, --output

set the output file.

• default: stdout

Command-line example:

$ checkstyle -o ./checkstyle.log [files...]
$ checkstyle --output ./checkstyle.log [files...]

-f, --format

specifies the output format.

• default: plain

• choices: xml, sarif, plain

Command-line example:

$ checkstyle -f xml [files...]
$ checkstyle --format sarif [files...]