Docker image configuration
Docker image paths
|Root directory of the project to be analyzed|
|Directory to store the analysis results, needs to be empty before running Qodana IntelliJ|
|IntelliJ IDEA configuration directory|
|Directory of the IntelliJ IDEA distributive|
|Used if a profile wasn't configured by run options or via |
The following arguments are available for the
|Project root folder (default: current working directory |
|Save results to folder (default: |
|Save HTML report to folder (default: |
|Set cache folder (default: |
|Generate HTML report|
|Serve HTML report on port 8080|
|Run in baseline mode. Provide the path to an exisitng SARIF report to be used in the baseline state calculation.|
|Include in the output report the results from the baseline run that are absent in the current run|
|Set the number of problems that will serve as a quality gate. If this number is reached, the inspection run is terminated.|
|Directory to be inspected. If not specified, the whole project is inspected by default|
|Name of a profile defined the in project. Note that the name of the profile does not necessarily match the name of the containing file stored in |
|Absolute path to the profile file|
|Inspect uncommitted changes and report new problems|
Examples of execution tuneup
Override the default inspection profile
If no profile is specified, the default
qodana.recommended profile is used. For more options of how to specify a profile, see Order of resolving a profile. For more about available profiles, see Set up a profile.
Save a report as HTML
By default, the HTML report is stored in a separate
report/ subdirectory under the
results directory. This location could be configured with
Display a report in HTML
After the inspection is finished, the container will not exit and will listen on port
8080. You can connect to
http://localhost:8080 to see the results. To stop the web server, press Ctrl-C in the Docker console.
Change the Heap size
By default, Heap size is set to 80% of the host RAM.
Log INFO messages to STDOUT
The default log level for STDOUT is
Provide different Gradle settings
Use a different 'idea.properties' file
Turn off user statistics
To disable the reporting of usage statistics, adjust the
The set of plugins depends on the selected Qodana linter.
You can add any free IntellJ platform plugins or your custom plugin by using the following command:
To optimize the most common cases, some bundled plugins are disabled by default. You can check the whole list of disabled plugins in
Java, Kotlin for Server Side, PHP, and their libraries'/frameworks' plugins are enabled by default. Gradle and Maven plugins are also enabled.
To change the plugins list, do any of the following:
disabled_plugins.txtby mounting your own file:docker run ... -v $empty_file$:/root/.config/idea/disabled_plugins.txt jetbrains/qodana
Use IDE properties
ordocker run ... -e IDE_PROPERTIES_PROPERTY='-Didea.suppressed.plugins.id=com.intellij.spring.security' jetbrains/qodana
Qodana IntelliJ lets you check only changed files:
You can adjust the
idea.required.plugins.id value and keep only the VCS plugin suitable for your project.
Run in baseline mode
In baseline run mode, each new Qodana IntelliJ run is compared to some initial run selected as a "baseline". This can help in situations when you have no possibility to fix old problems and rather want to prevent the appearance of new ones.
<baseline-path> is the path to a
qodana.sarif.json file from an earlier run. If the
--baseline-include-absent option is provided, the inspection results will include absent problems, that is the problems detected only in the baseline run but not in the current run.
After the inspection is finished, Qodana IntelliJ displays the summary of the current project state compared to the baseline.
where the detected problems are aggregated as follows:
new: The problem was detected only in the current run but not in the baseline run.
absent: The problem was detected only in the baseline run but not in the current run.
unchanged: The problem was detected both in the current run and in the baseline run.
The SARIF output report will contain the per-problem information on the baseline state.
Set a quality gate
Qodana IntelliJ lets you configure a "quality gate", that is, the number of problems that will act as a threshold. If the threshold number is reached, the inspection run is terminated.
When running in baseline mode, a threshold is calculated as the sum of new and absent problems. Unchanged results are ignored.
Run as non-root
By default, the container is run as the
root user so that Qodana IntelliJ can read any volumes bind-mounted with the project and write the results. As a result, files in the
results/ folder are owned by the
root after the run. To avoid this, you can run the container as a regular user:
Note that in this case the
results/ folder on host should already be created and owned by you. Otherwise, Docker will create it as
root and Qodana IntelliJ will not be able to write to it.
You can decrease the time for a Qodana IntelliJ run by persisting cache from one run to another. For example, package and dependency management tools such as Maven, Gradle, npm, and Yarn keep a local cache of downloaded dependencies.
By default, Qodana IntelliJ would save caches to folder
/data/cache inside container. This location could be changed via
--cache-dir cli argument. The data inside 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.
Example for local run:
In this case mapping the same
<cache-directory> would speed up the second run.
Order of resolving a profile
Qodana IntelliJ checks the configuration parameters for resolving the inspection profile in this order:
Profile with the name
%name%from the command-line option
Profile by the path
%path%from the command-line option
Profile with the name
Profile by the path
Profile mounted to
Fall back to using the default