Qodana

https://www.jetbrains.com/help/qodana/
Admin
Qodana is a code quality platform that integrates smart features from JetBrains IDEs and...
Tokens:250,740
Snippets:2,036
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Begin Qodana for JVM configuration

Source: https://www.jetbrains.com/help/qodana/configuration-reference.html

Starts a Qodana configuration for the JVM linter. The example is incomplete in the source, showing only the version field.

```yaml
version: "1.0"

```

--------------------------------

### Get help page for Qodana installer CLI

Source: https://www.jetbrains.com/help/qodana/shl-docker-configuration.html

Retrieves the help page for any available command in the Qodana Self-Hosted installer CLI.

```bash
docker run \
    -v /var/run/docker.sock:/var/run/docker.sock \
    quay.io/jetbrains/qodana-installer-cli:latest \
    help
```

--------------------------------

### Monorepo bootstrap example with frontend and backend

Source: https://www.jetbrains.com/help/qodana/configuration-reference.html

Example of a `qodana.yaml` file for a monorepo with a `frontend` directory (Node.js) and a `backend` directory (C#). The `bootstrap` key installs frontend dependencies and builds backend C# projects.

```yaml
version: "1.0"

linter: qodana-dotnet

bootstrap: |+
  set -eu

  # Install frontend dependencies
  echo "Installing frontend dependencies..."
  cd frontend && npm install && cd ..

  # Build backend C# projects
  echo "Building C# projects..."
  dotnet restore backend/MySolution.sln
  dotnet build backend/MySolution.sln --no-restore
```

--------------------------------

### Example qodana.yaml for PHP 7.1 to 8.0

Source: https://www.jetbrains.com/help/qodana/php-language-upgrade.html

Example qodana.yaml configuration for migrating from PHP 7.1 to 8.0.

```yaml
script:
  name: php-migration
  parameters:
      fromLevel: 7.1
      toLevel: 8.0
```

--------------------------------

### Example Docker command for PHP 7.1 to 8.0

Source: https://www.jetbrains.com/help/qodana/php-language-upgrade.html

Example Docker command for migrating from PHP 7.1 to 8.0.

```bash
$
docker run \
   -v <source-directory>/:/data/project/ \
   -e QODANA_TOKEN="<cloud-project-token>" \
   jetbrains/qodana-<image> \
   --script php-migration:7.1-to-8.0
```

--------------------------------

### Install Qodana CLI with installer script

Source: https://www.jetbrains.com/help/qodana/quick-start.html

Installs Qodana CLI using the official installer script. Suitable for macOS and Linux.

```bash
curl -fsSL https://jb.gg/qodana-cli/install | bash
```

--------------------------------

### Global configuration example with profile

Source: https://www.jetbrains.com/help/qodana/global-configuration.html

Shows a global configuration with failure conditions and a profile reference.

```yaml
failureConditions:
    severityThresholds:
        critical: 0

profile:
    name: qodana.recommended

```

--------------------------------

### Install Qodana CLI with Scoop

Source: https://www.jetbrains.com/help/qodana/quick-start.html

Installs Qodana CLI on Microsoft Windows using Scoop. First adds the JetBrains bucket, then installs qodana.

```powershell
scoop bucket add jetbrains https://github.com/JetBrains/scoop-utils
scoop install qodana
```

--------------------------------

### Example CLI command for PHP 7.1 to 8.0

Source: https://www.jetbrains.com/help/qodana/php-language-upgrade.html

Example CLI command for migrating from PHP 7.1 to 8.0.

```bash
$
qodana scan \
   -e QODANA_TOKEN="<cloud-project-token>" \
   --script php-migration:7.1-to-8.0
```

--------------------------------

### Qodana CLI with plugin properties

Source: https://www.jetbrains.com/help/qodana/configuration-reference.html

Command-line example for running Qodana with required and suppressed plugin properties.

```bash
qodana scan \
   -e QODANA_TOKEN="<cloud-project-token>" \
   --property=idea.required.plugins.id=JavaScript,org.intellij.grails \
   --property=idea.suppressed.plugins.id=com.intellij.spring.security
```

--------------------------------

### bootstrap key example in qodana.yaml

Source: https://www.jetbrains.com/help/qodana/configuration-reference.html

Shows the `bootstrap` key in a `qodana.yaml` file to run custom commands before analysis. Includes commented examples for PHP (Laravel), JavaScript (Node.js), and Python. The `set -eu` ensures the script exits on errors.

```yaml
version: "1.0"

linter: <linter>

bootstrap: |+
  set -eu
  # For PHP projects that use Laravel:
  #composer require --dev barryvdh/laravel-ide-helper

  # For JavaScript projects that use Node.js:
  #npm install

  # For Python projects
  #pip install -r requirements.txt
```

--------------------------------

### Install Qodana CLI with Homebrew

Source: https://www.jetbrains.com/help/qodana/quick-start.html

Installs Qodana CLI on macOS and Linux using Homebrew (recommended). Requires Docker or Podman installed and running locally; on Linux, Docker must be runnable under the current non-root user.

```bash
brew install jetbrains/utils/qodana
```

--------------------------------

### Aggregate installer logs with qodana-installer-cli logs

Source: https://www.jetbrains.com/help/qodana/shl-docker-configuration.html

Aggregates installer logs for all services. Mounts the Docker socket and runs the qodana-installer-cli logs command.

```bash
docker run \
    -v /var/run/docker.sock:/var/run/docker.sock \
    quay.io/jetbrains/qodana-installer-cli:latest \
    logs
```

--------------------------------

### Comprehensive Qodana configuration example

Source: https://www.jetbrains.com/help/qodana/configuration-reference.html

Comprehensive configuration example for Qodana. This is a minimal qodana.yaml file with version and linter keys. The linter value should be replaced with the actual linter name.

```yaml
version: "1.0"

linter: <linter>
```

--------------------------------

### Project configuration example

Source: https://www.jetbrains.com/help/qodana/global-configuration.html

Shows a project configuration with a linter and failure conditions, including severity thresholds for critical and any.

```yaml
linter: jetbrains/qodana-jvm:2025.2

failureConditions:
    severityThresholds:
        critical: 1
        any: 10

```

--------------------------------

### prepare-qodana.sh script example

Source: https://www.jetbrains.com/help/qodana/configuration-reference.html

Example of a `prepare-qodana.sh` shell script to be saved in the project root. It includes commented commands for PHP and JavaScript projects. The script is intended to be run in a Qodana Docker container via the `bootstrap` key.

```shell
#! /bin/sh

set -eu

# For PHP projects that use Laravel:
#composer require --dev barryvdh/laravel-ide-helper

# For JavaScript projects that use Node.js:
#npm install
```

--------------------------------

### Install Qodana CLI with winget

Source: https://www.jetbrains.com/help/qodana/quick-start.html

Installs Qodana CLI on Microsoft Windows using Windows Package Manager (recommended).

```powershell
winget install -e --id JetBrains.QodanaCLI
```

--------------------------------

### RabbitMQ permissions example

Source: https://www.jetbrains.com/help/qodana/shl-docker-configuration.html

Example JSON for granting configure, write, and read permissions to a RabbitMQ user on a virtual host.

```json
{
  "user": "qodana_user",
  "vhost": "/qodana",
  "configure": ".*",
  "write": ".*",
  "read": ".*"
}
```

--------------------------------

### Bootstrap dependency installation in qodana.yaml

Source: https://www.jetbrains.com/help/qodana/js.html

Add this line to qodana.yaml to automatically run a command before analysis, for example to install dependencies specified by yarn.lock. You can use pnpm, npm, or yarn commands.

```yaml
bootstrap: yarn install
```

--------------------------------

### Example project structure for global configuration

Source: https://www.jetbrains.com/help/qodana/global-configuration.html

Shows a directory layout where project-a and project-b contain qodana.yaml files, project-b also has a custom profile, and a global configuration file qodana-global-configurations.yaml is at the root.

```text
root/
    project-a/
        qodana.yaml
    project-b/
        qodana.yaml
        project-b-profile.yaml
    qodana-global-configurations.yaml

```

--------------------------------

### Global configuration file example

Source: https://www.jetbrains.com/help/qodana/global-configuration.html

Defines two configurations (project_a and project_b) with id, name, description, and qodanaYaml fields. The qodanaYaml path is relative to the global configuration file.

```yaml
configurations:
    - id: project_a
      name: Project A # Displayed in Qodana Cloud UI
      description: Description for configuration project A # Displayed in Qodana Cloud UI
      qodanaYaml: project-a/qodana.yaml # Path to the config file relatively to file

    - id: project_b
      name: Project B
      description: Description for configuration project B
      qodanaYaml: project-b/qodana.yaml

```

--------------------------------

### Customized users request with curl

Source: https://www.jetbrains.com/help/qodana/cloud-api.html

Example curl request that returns ten user entries starting from the second entry, only if they contain 'abc' in the email or displayName fields, sorted in descending order. Requires a permanent organization token.

```bash
curl -X GET \
   "https://qodana.cloud/api/v1/public/organizations/users?limit=10&offset=1&order=DESC&search=abc" \
   -H "Authorization: Bearer $permanent_organization_token"
```

--------------------------------

### Deploy Qodana Self-Hosted with configuration from file

Source: https://www.jetbrains.com/help/qodana/shl-docker-configuration.html

Runs install-app using the --env-file option to load configuration from qodana-self-hosted.env. The same flag can be used for subsequent commands like backup, credentials, or environment for consistent behavior.

```bash
$
docker run
    -v /var/run/docker.sock:/var/run/docker.sock \
    -e API_ORGANIZATION_NAME="<Specify the name of your organization>" \
    -e COMMON_LICENSE_KEY_SECRET="<Specify a valid license key>" \
    --env-file qodana-self-hosted.env \
    quay.io/jetbrains/qodana-installer-cli:latest \
    install-app

```

--------------------------------

### Configure bootstrap key for dependency installation

Source: https://www.jetbrains.com/help/qodana/ruby.html

Configure the bootstrap key in your YAML configuration to install external dependencies before analysis. The command runs automatically before analysis and uses bundle install to install dependencies.

```yaml
bootstrap: |
  sudo apt-get update &&
  sudo apt-get install -y <list of libraries> &&
  bundle install
```

--------------------------------

### Install specific Qodana CLI version

Source: https://www.jetbrains.com/help/qodana/quick-start.html

Installs a nightly or any other version of Qodana CLI using the installer script. Replace 'nightly' with the desired version.

```bash
curl -fsSL https://jb.gg/qodana-cli/install | bash -s -- nightly
```

--------------------------------

### Install Helm on control plane node

Source: https://www.jetbrains.com/help/qodana/shl-kubernetes-configuration.html

Run this command on the control plane node to install Helm. It downloads and executes the official Helm installation script.

```bash
$
curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash
```

--------------------------------

### Example repository structure

Source: https://www.jetbrains.com/help/qodana/configuration-reference.html

Shows a typical project structure where repo/.git contains information accessible to Qodana and repo/project contains the project to be inspected.

```text
repo/
.git/
project/
...
```

--------------------------------

### Install Qodana CLI with Chocolatey

Source: https://www.jetbrains.com/help/qodana/quick-start.html

Installs Qodana CLI on Microsoft Windows using Chocolatey.

```powershell
choco install qodana
```

--------------------------------

### List used variables with qodana-installer-cli environment

Source: https://www.jetbrains.com/help/qodana/shl-docker-configuration.html

Displays every configurable variable with its resolved value. Use the same flags as for install-app to see effective values.

```bash
docker run \
    --env-file qodana.env \
    -v /var/run/docker.sock:/var/run/docker.sock \
    quay.io/jetbrains/qodana-installer-cli:latest \
    environment
```

--------------------------------

### Disable inspection in bar.yaml

Source: https://www.jetbrains.com/help/qodana/inspection-profiles.html

Example of a profile file (bar.yaml) that disables Inspection1. Used in the import example.

```yaml
inspections:
  - inspection: Inspection1
    enabled: false
```

--------------------------------

### Run Qodana Docker image with --diff-start

Source: https://www.jetbrains.com/help/qodana/analyze-pr.html

Run Qodana Docker image with the --diff-start option to analyze changes. Mount the current directory to /data/project/ and provide the QODANA_TOKEN environment variable. Replace <image> with the appropriate Qodana image name.

```bash
docker run \
   -v $(pwd):/data/project/ \
   -e QODANA_TOKEN="<cloud-project-token>" \
   jetbrains/qodana-<image> \
   --diff-start=<GIT_START_HASH>
```

--------------------------------

### Qodana CLI scan with --baseline

Source: https://www.jetbrains.com/help/qodana/php.html

Command-line example for running Qodana for PHP with the baseline feature using the Qodana CLI. Mounts the baseline directory and specifies the baseline file path. Requires a cloud project token.

```bash
$
qodana scan \
    -v <path_to_baseline>:/data/base/ \
    -e QODANA_TOKEN="<cloud-project-token>" \
    --linter qodana-php \
    --within-docker true
    --baseline /data/base/<path-relative-to-project-dir>/qodana.sarif.json
```

--------------------------------

### Configuration example placeholder

Source: https://www.jetbrains.com/help/qodana/shl-kubernetes-configuration.html

Placeholder for a complete values.yaml example containing the modifications described on this page. The actual content is not shown.

```yaml
global: {...}

```

--------------------------------

### Enable inspections in foo.yaml

Source: https://www.jetbrains.com/help/qodana/inspection-profiles.html

Example of a profile file (foo.yaml) that enables Inspection1, Inspection2, and Inspection3. Used in the import example.

```yaml
inspections:
  - inspection: Inspection1
    enabled: true
  - inspection: Inspection2
    enabled: true
  - inspection: Inspection3
    enabled: true
```

--------------------------------

### Qodana CLI scan with --diff-start

Source: https://www.jetbrains.com/help/qodana/python.html

Command line example for analyzing changes in code using the --diff-start option with a base commit hash. It sets the QODANA_TOKEN environment variable and uses the qodana-python<-community> linter with --within-docker false.

```bash
$
qodana scan \
   -e QODANA_TOKEN="<qodana-cloud-token>" \
   --linter qodana-python<-community> \
   --within-docker false \
   --diff-start=<GIT_START_HASH>

```

--------------------------------

### RabbitMQ example definition in JSON

Source: https://www.jetbrains.com/help/qodana/shl-docker-configuration.html

Example RabbitMQ configuration. The source shows a placeholder and refers to the RabbitMQ website for full details.

```json
{ {...}
```

--------------------------------

### Docker run Qodana .NET with --diff-start

Source: https://www.jetbrains.com/help/qodana/dotnet.html

Docker command to run Qodana for .NET with `--diff-start` for analyzing changes. Mounts the current directory to `/data/project/` and requires a cloud project token.

```bash
$
docker run \
   -v $(pwd):/data/project/ \
   -e QODANA_TOKEN="<cloud-project-token>" \
   jetbrains/qodana-dotnet:2026.2 \
   --diff-start=<GIT_START_HASH>
```

--------------------------------

### Get project metadata with GET /api/v1/public/organizations/projects

Source: https://www.jetbrains.com/help/qodana/cloud-api.html

Retrieves project metadata for the default branch of a project. Accepts an optional projectName query parameter.

```http
GET https://qodana.cloud/api/v1/public/organizations/projects?projectName={projectName}
```

--------------------------------

### Run Qodana scan with --diff-start from command line

Source: https://www.jetbrains.com/help/qodana/jvm.html

Command-line analysis of changes using --diff-start with a base commit hash. Requires a Qodana Cloud token and a specific linter placeholder. Open Qodana Cloud to examine reports.

```bash
$
qodana scan \
   -e QODANA_TOKEN="<qodana-cloud-token>" \
   --linter qodana-<jvm|android><-community|-android> \
   --within-docker false \
   --diff-start=<GIT_START_HASH>
```

--------------------------------

### RabbitMQ user creation example

Source: https://www.jetbrains.com/help/qodana/shl-docker-configuration.html

Example JSON for creating a RabbitMQ user with administrator tag. The username and password are typically provided via environment variables.

```json
{
  "name": "qodana_user",
  "password": "secure_password",
  "tags": "administrator"
}
```

--------------------------------

### Qodana CLI scan with qodana.recommended profile

Source: https://www.jetbrains.com/help/qodana/cloud-configure-for-os-projects.html

Use this Qodana CLI command to enable the qodana.recommended profile directly in the application configuration. Replace <cloud-project-token> and <linter> with your actual values.

```bash
$
qodana scan \
    -e QODANA_TOKEN="<cloud-project-token>" \
    --profile-name qodana.recommended \
    --linter <linter>
```

--------------------------------

### Bootstrap composer install in qodana.yaml

Source: https://www.jetbrains.com/help/qodana/php.html

Add this line to qodana.yaml to install project dependencies before analysis. The --ignore-platform-reqs option bypasses PHP version incompatibility issues.

```yaml
bootstrap: composer install --ignore-platform-reqs
```

--------------------------------

### Example pipeline configuration with inputs block

Source: https://www.jetbrains.com/help/qodana/gitlab.html

Example pipeline configuration using the inputs block to set the image, push-fixes, and args for the Qodana GitLab CI component.

```yaml
include:
   - component: $CI_SERVER_FQDN/qodana/qodana/qodana-gitlab-ci@v2026.2
     inputs:
        image: jetbrains/qodana-<image>:<version>
        push-fixes: merge-request
        args: --apply-fixes
```

--------------------------------

### Upgrade Qodana CLI to a specific version using installer

Source: https://www.jetbrains.com/help/qodana/update-qodana.html

Use this command to upgrade Qodana CLI to a specific version (e.g., v2026.2.1) using the official installer script.

```bash
curl -fsSL https://jb.gg/qodana-cli/install | bash -s -- v2026.2.1
```
Tokens:
Raw