Configuration options
This section explains how you can configure Qodana linters using configuration of the tools that will be used for running like Docker, GitHub Actions, GitLab CI/CD, and other tools.
In several cases, settings mentioned in this section are also available for configuring via the qodana.yaml
file, which is also mentioned in this section.
Types of options
You can configure Qodana using three types of options as shown below.
Option type | Example |
---|---|
Requires the equal sign ( |
|
Requires the space character ( |
|
Requires no argument |
|
Here is the example command that invokes all these options:
In the runner configuration, find the
field and specify the path to the plugin file:Configure projects
Option | Description | The default value |
---|---|---|
| Set a custom configuration file instead of | None |
| Force initialization, overwrite the existing valid | None |
| Specify the root directory of your project |
|
You can invoke these options in Qodana CLI using the qodana init <options>
command.
Analyze projects
Option | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| In place of
Also, you can use any Docker image that has Qodana. | ||||||||||||||||||||||||||||
| Run Qodana in native mode. Not compatible with the
To employ EAP versions of Qodana, append | ||||||||||||||||||||||||||||
| Root directory of the analyzed project. The default value is | ||||||||||||||||||||||||||||
| Override the directory for saving Qodana analysis results. The default value is | ||||||||||||||||||||||||||||
| Override the cache directory. The default value is | ||||||||||||||||||||||||||||
| Override the directory for saving Qodana HTML reports. The default value is | ||||||||||||||||||||||||||||
| Print in the CLI output all problems found by Qodana | ||||||||||||||||||||||||||||
| Generate a SARIF-formatted Code Climate report supported by GitLab CI/CD. The report will be saved in the directory specified by the | ||||||||||||||||||||||||||||
| Generate a Code Insights report supported by Bitbucket Cloud. By default, this option is enabled if Qodana is being run in the Bitbucket Pipelines | ||||||||||||||||||||||||||||
| Clear the local Qodana cache before running analyses | ||||||||||||||||||||||||||||
| Serve an HTML report on the port specified by the | ||||||||||||||||||||||||||||
| Port to serve the report. The default value is | ||||||||||||||||||||||||||||
| Set a custom configuration file instead of | ||||||||||||||||||||||||||||
| Unique report identifier (GUID) to be used by Qodana Cloud. The default value is | ||||||||||||||||||||||||||||
| Provide the path to an existing SARIF report to be used in the baseline state calculation | ||||||||||||||||||||||||||||
| Include baseline problems that are marked absent in the output report | ||||||||||||||||||||||||||||
| Go through the full commit history and run the analysis on each commit. If combined with | ||||||||||||||||||||||||||||
| Reset Git and run analysis only for the files modified since the given commit. If combined with the | ||||||||||||||||||||||||||||
| Set the number of problems that will serve as a quality gate. Once the quality gate threshold is reached, the analysis will be terminated with a non-zero exit code | ||||||||||||||||||||||||||||
| Skip the inspections configured by the | ||||||||||||||||||||||||||||
| Specify the directory inside the | ||||||||||||||||||||||||||||
| Specify the profile name | ||||||||||||||||||||||||||||
| Specify the path to the profile file | ||||||||||||||||||||||||||||
| Set this option to | ||||||||||||||||||||||||||||
| Override the run scenario of Qodana. Currently, the following run scenarios are available:
| ||||||||||||||||||||||||||||
| Specify the directory that contains code coverage data for analysis | ||||||||||||||||||||||||||||
| Apply all available quick-fix strategies including cleanup, see the Quick-fix section for details | ||||||||||||||||||||||||||||
| Run the | ||||||||||||||||||||||||||||
| Set a JVM property to be used while running Qodana. Use the | ||||||||||||||||||||||||||||
| Generate an HTML report. This option is enabled by default | ||||||||||||||||||||||||||||
| Set Qodana analysis time limit in milliseconds. Once reached, the analysis will be terminated and the process will exit with the | ||||||||||||||||||||||||||||
| Override the default | ||||||||||||||||||||||||||||
| Set the hash of the commit that will act as a base for comparison in a change analysis | ||||||||||||||||||||||||||||
| Set the hash of the commit that will act as an end in a change analysis. This lets you analyze only files changed between the | ||||||||||||||||||||||||||||
| Disable sending anonymous statistics | ||||||||||||||||||||||||||||
| Specify the path to the | ||||||||||||||||||||||||||||
| Set additional arguments, see the C / C++ section for details | ||||||||||||||||||||||||||||
| Set a relative path to a solution file, see the .NET section for details | ||||||||||||||||||||||||||||
| Set a relative path to a project file, see the .NET section for details | ||||||||||||||||||||||||||||
| Specify the build configuration, see the .NET section for details | ||||||||||||||||||||||||||||
| Specify the build platform, see the .NET section for details | ||||||||||||||||||||||||||||
| Skip project building before analyses, see the .NET section for details | ||||||||||||||||||||||||||||
| Define environment variables for the Qodana container, multiple variables can be specified. For security reasons, Qodana CLI does not read environment variables from the host operating system, so all variables required by Qodana should be specified explicitly. | ||||||||||||||||||||||||||||
| Define additional volumes for the Qodana container, multiple volumes can be specified. For example, | ||||||||||||||||||||||||||||
| User to run Qodana container as. Please specify the user ID – | ||||||||||||||||||||||||||||
| Skip pulling the latest Qodana container |
You can invoke these options in Qodana CLI using the qodana scan <options>
command.
Send analysis reports to Qodana Cloud
Option | Description |
---|---|
| The unique report identifier (GUID) to be used by Qodana Cloud. The default value is |
| Set a custom configuration file instead of |
| Override the linter which report will be used for sending to Qodana Cloud |
| Root directory of the project which report will be sent to Qodana Cloud. The default value is |
| Override the directory for saving Qodana HTML reports. The default value is |
| Override the directory that will be used for sending a Qodana report from. The default value is |
You can invoke these options in Qodana CLI using the qodana send <options>
command.
View reports
Option | Description |
---|---|
| Set a custom configuration file instead of |
| Open the report directory only without serving it |
| Override the linter which report should be viewed |
| Specify the port to serve a report. The default value is |
| Root directory of the project which report should be viewed. The default value is |
| Override the directory to save a Qodana HTML report. This is the directory that contains the |
| Override the directory for saving analysis results. The default value is |
You can invoke these options in Qodana CLI using the qodana show <options>
command.
View SARIF-formatted files
Option | Description | Default setting |
---|---|---|
| Path to the SARIF-formatted file |
|
You can invoke these options in Qodana CLI using the qodana view <options>
command.
Count contributors
To collect information about contributors to your project, you can run Qodana using the following options.
Option | Description | Default setting |
---|---|---|
| The number of days in the past that should be used for calculating the number of active contributors | 90 |
| The output format. Available values are |
|
| The Directory of the project that can be specified multiple times to check multiple projects |
|
You can invoke these options in Qodana CLI using the qodana contributors <options>
command.
View project statistics
You can use these options to view information about your project, such as languages and lines of code.
Option | Description |
---|---|
| The output format that accepts the |
| The project directory. This option can be specified multiple times to check multiple projects. If not specified, the current directory will be used |
You can invoke these options in Qodana CLI using the qodana cloc <options>
command.
Pull a Qodana image
Using these options, you can pull the Qodana linter that you would like to employ.
Option | Description |
---|---|
| Set a custom configuration file instead of |
| Specify the linter that you would like to pull |
| The root directory of the analyzed project. If not specified, the current directory will be used |
You can invoke these options in Qodana CLI using the qodana pull <options>
command. Qodana CLI takes information about the linter using either the qodana.yaml
file configuration or the --linter
option.
Generate an autocompletion script
Using these options, you can generate an autocompletion script for a specific shell.
Command | Description |
---|---|
| Generate the autocompletion script for bash |
| Generate the autocompletion script for fish |
| Generate the autocompletion script for PowerShell |
| Generate the autocompletion script for zsh |
You can invoke these options in Qodana CLI using the qodana completion <options>
command.
Configure update checking and log levels
Option | Description |
---|---|
| Disable checking and notification about new versions of Qodana CLI |
| Change log level in the output of Qodana CLI. For example, you can set |
Configuration examples
Paths in linters
This table lists the paths available in Qodana linters.
Path | Description |
---|---|
| Root directory of the project |
| Directory to store the analysis results. It should be empty before running Qodana |
| IDE distributive directory |
| IDE configuration directory |
| The default profile file containing the |
| Directory for binding profile files |
| Maven project dependencies |
| Directory for overriding the |
| Gradle project dependencies |
| NuGet project dependencies |
| Directory for mapping code coverage files |
You can find below several examples of how these paths can be applied.
Override the default inspection profile
By default, Qodana employs the qodana.starter
profile, but you can bind and use your own profile instead:
In the runner configuration, find the
dropdown list and select the option. In the field that appears below the dropdown list, specify the path to your profile file relatively to the project root.To learn more about profiles, see the order of resolving a profile and Set up a profile sections in this documentation.
Override Gradle settings
For JVM linters, you can override the default Gradle settings:
In the runner configuration, find the
field and specify the path to the file containing new Gradle settings:View Qodana logs
Depending on the tool, you can view log files generated by Qodana:
You can mount the $(pwd)/.qodana/results/
directory to the /data/results
directory of the Docker image:
Once the Qodana run is complete, you can view log files in the $(pwd)/.qodana/results/
directory.
After running Qodana, in the project root run the $ qodana show -d
command for opening the directory containing log files.
Directories
Using these options, you can override the paths described in the Docker image paths section.
Option | Default setting | |
---|---|---|
| Root directory of the inspected project. Files and directories contained in the outside directory are not used while running Qodana |
|
| Directory to save Qodana inspection results to |
|
| Directory for saving the generated HTML report. To open the report, you will need to add the |
|
| Directory to store cache |
|
| Directory inside Files and directories contained in the outside directory like | None |
Override the report directory
This Docker command overrides the default report directory using the --report-dir
option, and saves the generated report to the local filesystem using the --save-report
option:
The generated report is saved to the local filesystem as configured by the -v <html-report-directory>:/data/results/newreportdir/
line in this command.
Cache dependencies
You can improve Qodana performance by persisting cache between runs. For example, package and dependency management tools such as Maven, Gradle, npm, Yarn, and NuGet keep a local cache of downloaded dependencies.
By default, Qodana save caches to the /data/cache
directory inside a container. You can override this location using the --cache-dir
option. This data is per-repository, so you can pass cache from branch-a
to build checking branch-b
. In this case, only new dependencies would be downloaded if they were added.
In a GitHub workflow, you can use dependency caching. GitLab CI/CD also has the cache that can be stored only inside the project directory. In this case, you can exclude the cache directory from inspection via qodana.yaml
.
This command maps the local directory with the /data/cache
directory of the Docker image, which saves cache to your local filesystem:
Using the --cache-dir
option, you can override the cache directory:
In the runner configuration, find the
field and specify the path to the cache directory:Profile
By default, Qodana inspects your code using the qodana.starter
profile.
You can configure and override Qodana profiles either in the qodana.yaml
file, or using the options from this table.
Option | Description | Default setting |
---|---|---|
| Skip running the inspections configured by the | Enabled |
| The profile name from the list of predefined Qodana profiles, or a profile name of a custom profile stored in XML-formatted profile files as You can also configure this option using the |
|
| The absolute path to the profile file. You can also configure this option using the | None |
| Run promo inspections as a part of the | Enabled only if Qodana is configured for the |
Profile name
The --profile-name
option lets you run Qodana using either the default profiles or the profile name from a custom profile.
This command lets you override the default profile und run Qodana using the qodana.recommended
profile:
In the runner configuration, find the
field and specify the profile name:To run Qodana with a custom profile, use its actual profile name.
The following lets you bind a custom profile:
In the runner configuration, find the
field and specify the custom profile name:Profile path
The --profile-path
option lets you override the path to the file containing the profile.
This command lets you bind the file to the profile directory, and the --profile-path
option tells Qodana which profile file to read:
In the runner configuration, find the
field and specify the path your custom profile:Custom configuration file
Your project can have several Qodana configurations contained in YAML-formatted files. This comes in handy if you analyze monorepo projects or run a single CI job.
You can use the --config
option and a path to a file relatively to the project root:
In the runner configuration, find the
field and specify the path to your custom configuration file:Baseline
In the baseline run mode, each new Qodana run is compared to some initial run. This can help in situations when you have no possibility to fix old problems and rather want to prevent the appearance of new ones.
To use the baseline feature, first run Qodana, and in the report UI select the problems that will be considered as baseline. Finally, save the SARIF-formatted file containing the baseline problems.
This is the list of baseline-related options:
Option | Description |
---|---|
| Run Qodana in the baseline mode. Provide the path to an existing SARIF report to be used in the baseline state calculation |
| Include in the output report the results from the baseline run that are absent during the current analysis |
This command invokes all baseline options:
In the runner configuration, find the
field and configure a baseline:Here, the <path-to-the-SARIF-file>
is the path to a qodana.sarif.json
file relative to the project root and taken from a previous Qodana run. If --baseline-include-absent
is invoked, the inspection results will include absent problems or the problems detected only in the baseline run but not in the current run.
Based on this run, the SARIF output report will contain the per-problem information on the baseline state.
Code coverage
You can run the code coverage by mapping the directory containing code coverage files to the /data/coverage
directory of a Qodana linter image:
In the runner configuration, find the
field and specify the path the file containing code coverage results:Report
This table contains the options related to reports:
Option | Description |
---|---|
| Generate and save HTML-formatted reports |
| Serve HTML-formatted reports. By default, port |
Save the report
The --save-report
option in the Docker command lets you save the generated HTML report to your local filesystem:
Show the report
This command runs the web server on port 4040 of a host machine, so your report will be available on http://localhost:4040:
Alternatively, in the project root you can run the qodana show
command.
To stop the web server, press Ctrl-C in the Docker console.
Quality gate
Qodana lets you configure a quality gate or the number of problems that will act as a threshold. Once the threshold is exceeded, the inspection run is terminated.
Option | Description |
---|---|
| Set the number of problems that will serve as a quality gate |
Here is the command that tells Qodana to fail the build in case the number of problems exceeds 10:
In the runner configuration, find the
field and specify a quality gate:If you run Qodana with the baseline mode enabled, a threshold is calculated as the sum of new and absent problems. The unchanged results are ignored.
Quick-fix
To apply quick-fix strategies to your codebase, you can invoke the --fixes-strategy
option.
In the runner configuration, find the
field and specify the preferred quick-fix strategy:Properties
Using the --property=
option, you can override various Qodana parameters:
Option | Description |
---|---|
| Set a JVM property using this notation: --property=property.name=value1,...,valueN This option can be repeated multiple times for setting multiple JVM properties. |
Log INFO messages to STDOUT
The default log level for STDOUT is WARN
. You can override it using the idea.log.config.file
property.
In the runner configuration, find the
field and specify the preferred quick-fix strategy:Disable user statistics
To disable reporting of usage statistics, adjust the idea.headless.enable.statistics
value of the --property
option:
In the runner configuration, find the
field and specify the required property:Configure plugins
Using the idea.required.plugins.id
and idea.suppressed.plugins.id
properties, you can specify the plugins required for a specific run, and the list of plugins that will be suppressed:
In the runner configuration, find the
field and specify the required properties:Analysis of changes
Option | Description |
---|---|
| Run incremental analysis on a change set like merge or pull requests |
If you just finished work and would like to analyze the changes, you can employ the --diff-start
option and specify a hash of the commit that will act as a base for comparison, see the Analyze changes section for details:
In the runner configuration, find the
field and specify the commit hash:To analyze a set of changes between two commits, employ both --diff-start
and --diff-end
options:
In the runner configuration, find the
field and specify the commit hashes:Run scenario
Option | Description | Default setting |
---|---|---|
| Override the default run scenario |
|
Application of the default
run scenario is equivalent to running this command:
In the runner configuration, find the
field and specify the preferred run scenario:For the PHP version migration scenario, use this command:
In the runner configuration, find the
field and specify the PHP version migration run scenario:Forward reports to Qodana Cloud
To forward reports to Qodana Cloud, you can set the list of Docker environments as explained in the Forward reports section.
Alternatively, see the Send analysis reports to Qodana Cloud chapter of this section.
Change the Heap size
By default, the Heap size is set to 80% of the host RAM. You can configure this setting using the _JAVA_OPTIONS
variable:
In the runner configuration, find the _JAVA_OPTIONS
variable:
To learn more about configuring the Heap, see the Heap Tuning Parameters of the Oracle documentation.
Override the idea.properties file
The idea.properties
configures the default locations of the IDE files.
You can override the idea.properties
file using the IDEA_PROPERTIES
variable:
In the runner configuration, find the IDEA_PROPERTIES
variable:
Configure root and non-root users
By default, a Docker container runs under the root
user, so Qodana can read project information and write inspection results. Therefore, all files in the results/
directory are owned by the root
user after the run.
To overcome this, you can run the container as a regular user:
In this case, the results/
directory on the host should already be created and owned by you. Otherwise, Docker will create it as the root
user, and Qodana will not be able to write to it.
TeamCity and Qodana CLI run Qodana using a current non-root user. This can be inconvenient if you wish to install dependencies using the apt
tool invoked in the bootstrap
section.
To run Qodana as a root user in TeamCity, add the -u root
option in the field of the Qodana runner configuration.
To run Qodana CLI as a root user, you can append -u root
option to the qodana scan
command:
Cache in Qodana CLI
Qodana CLI stores files in the <userCacheDir>
directory, which is mentioned several times throughout this section. Here is the list of <userCacheDir>
directory locations depending on the operating system:
Operating System | Path |
---|---|
macOS |
|
Linux |
|
Windows |
|
If you run the qodana init
command in the project directory, Qodana CLI will let you choose the linter that will be run during inspection, and save the choice in qodana.yaml
. Once done, you do not need to specify the linter in the commands, which is shown throughout this section.
The detailed description of the qodana init
command is available in the Configure projects section.