Run detekt using Command Line Interface - Detekt

import CliOptions from "./_cli-options.md"; import CliGeneratorOptions from "./_cli-generator-options.md";

Install the cli

There are different ways to install the Command Line Interface (CLI):

MacOS, with Homebrew:

brew install detekt
detekt [options]

Windows, with Scoop

powershell

scoop install detekt
detekt [options]

Any OS:

curl -sSLO https://github.com/detekt/detekt/releases/download/v1.23.5/detekt-cli-1.23.5.zip
unzip detekt-cli-1.23.5.zip
./detekt-cli-1.23.5/bin/detekt-cli --help

NixOS

As a prerequisite, you have to add the unstable channel via nix-channel and then execute the following command.

nix-shell -I nixpkgs=channel:nixpkgs-unstable -p detekt

Use the cli

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.

Use the cli to generate configuration for custom rules

java -jar detekt-generator-1.23.5-all.jar -gcrc -i /path/to/rule1, /path/to/rule2