title | keywords | sidebar | permalink | folder | summary | sidebar_position | |
---|---|---|---|---|---|---|---|
Run detekt using Command Line Interface |
|
cli.html |
gettingstarted |
1 |
import CliOptions from "./_cli-options.md"; import CliGeneratorOptions from "./_cli-generator-options.md";
There are different ways to install the Command Line Interface (CLI):
MacOS, with Homebrew:
brew install detekt
detekt [options]
Windows, with Scoop
scoop install detekt
detekt [options]
curl -sSLO https://github.com/detekt/detekt/releases/download/v[detekt_version]/detekt-cli-[detekt_version].zip
unzip detekt-cli-[detekt_version].zip
./detekt-cli-[detekt_version]/bin/detekt-cli --help
detekt will exit with one of the following exit codes:
Exit code | Description |
---|---|
0 | detekt ran normally and maxIssues count was not reached in BuildFailureReport. |
1 | An unexpected error occurred |
2 | MaxIssues count was reached in BuildFailureReport. |
3 | Invalid detekt configuration file detected. |
The following parameters are shown when --help
is entered.
java -jar detekt-generator-[detekt_version]-all.jar -gcrc -i /path/to/rule1, /path/to/rule2