CLI オプション一覧

このセクションでは、Docker、GitHub アクション、GitLab CI/CD などの実行に使用されるツールの構成を使用して、Qodana リンターを構成する方法について説明します。

多くの場合、このセクションで説明する設定は、このセクションでも説明する qodana.yaml ファイル経由で構成することもできます。

オプションの種類

Qodana は、以下に示す 3 種類のオプションを使用して設定できます。

オプション型	サンプル
オプション名とその引数の間に等号 (`=`) が必要です	`--property=idea.log.config.file=info.xml`
オプション名とその引数の間にスペース文字 ( ) が必要です	`--baseline /path/to/sarif/file`
引数は必要ありません	`--apply-fixes`

これらすべてのオプションを呼び出すコマンドの例を次に示します。

                    docker run \
                       -v $(pwd):/data/project/ \
                       -e QODANA_TOKEN="<cloud-project-token>" \
                       <image-name> \
                       --property=idea.log.config.file=info.xml \
                       --baseline <baseline-path> \
                       --apply-fixes
                

                    qodana scan \
                       -e QODANA_TOKEN="<cloud-project-token>" \
                       --property=idea.log.config.file=info.xml \
                       --baseline <baseline-path> \
                       --apply-fixes
                

                    name: Qodana
                    on:
                        workflow_dispatch:
                        pull_request:
                        push:
                            branches: # Specify your branches here
                                - main # The 'main' branch
                                - master # The 'master' branch
                                - 'releases/*' # The release branches
                    jobs:
                        qodana:
                            runs-on: ubuntu-latest
                            permissions:
                                contents: write
                                pull-requests: write
                                checks: write
                            steps:
                                - uses: actions/checkout@v3
                                  with:
                                      ref: ${{ github.event.pull_request.head.sha }}  # to check out the actual pull request commit, not the merge commit
                                      fetch-depth: 0  # a full history is required for pull request analysis
                                - name: 'Qodana Scan'
                                  uses: JetBrains/qodana-action@v2026.2
                                  with:
                                      args: |
                                          --property=idea.log.config.file=info.xml
                                          --baseline <baseline-path>
                                          --apply-fixes
                                  env:
                                      QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}
                

                        pipeline {
                            environment {
                                QODANA_TOKEN=credentials('qodana-token')
                            }
                            agent {
                                docker {
                                    args '''
                                      -v "${WORKSPACE}":/data/project
                                      --entrypoint=""
                                      '''
                                    image 'jetbrains/qodana-<image>'
                                }
                            }
                            stages {
                                stage('Qodana') {
                                    steps {
                                        sh '''
                                        qodana \
                                        --property=idea.log.config.file=info.xml \
                                        --baseline <baseline-path> \
                                        --apply-fixes
                                        '''
                                    }
                                }
                            }
                        }
                    

                        include:
                            - component: $CI_SERVER_FQDN/qodana/qodana/qodana-gitlab-ci@v2026.2
                              inputs:
                                  args: |
                                      --property=idea.log.config.file=info.xml
                                      --baseline <baseline-path>
                                      --apply-fixes
                                      --image <image>
                    

ランナー設定で、追加の Qodana 引数フィールドを見つけて、プラグインファイルへのパスを指定します。

                        --property=idea.log.config.file=info.xml --baseline <baseline-path> --apply-fixes
                    

プロジェクトの構成

オプション	説明	デフォルト値
`--config <string>`	`qodana.yaml` の代わりにカスタム構成ファイルを設定します。プロジェクトディレクトリからの相対パスを使用します	なし
`-f, --force`	強制的に初期化し、既存の有効な `qodana.yaml` ファイルを上書きします	なし
`-i, --project-dir <string>`	プロジェクトのルートディレクトリを指定します	`.`

qodana init <options> コマンドを使用して、Qodana CLI でこれらのオプションを呼び出すことができます。

プロジェクトを分析する

オプション

説明

--image <string>

<string> の代わりに、使用する Qodana Docker イメージを指定します。

Docker イメージ	説明
`jetbrains/qodana-jvm-community:2026.2`	JVM の Qodana コミュニティ
`jetbrains/qodana-jvm:2026.2`	JVM 用 Qodana
`jetbrains/qodana-jvm-android:2026.2`	Android のための Qodana コミュニティ
`jetbrains/qodana-android:2026.2`	Android 用 Qodana
`jetbrains/qodana-php:2026.2`	PHP 用の Qodana
`jetbrains/qodana-python:2026.2`	Python 用 Qodana
`jetbrains/qodana-python-community:2026.2`	Python のための Qodana コミュニティ
`jetbrains/qodana-js:2026.2`	JS 用 Qodana
`jetbrains/qodana-go:2026.2`	Go 用 Qodana
`jetbrains/qodana-dotnet:2026.2`	.NET 用 Qodana
`jetbrains/qodana-cdnet:2026.2`	.NET の Qodana コミュニティ
`jetbrains/qodana-cpp:2026.2`	C/C++ 用 Qodana
`jetbrains/qodana-clang:2026.2`	C/C++ のための Qodana コミュニティ
`jetbrains/qodana-ruby:2026.2-eap`	Ruby 用 Qodana

また、Qodana を含む任意の Docker イメージを使用することもできます。

-l, --linter <string>

<string> の代わりに、使用するリンターを指定します。

リンター名	説明
`qodana-jvm-community`	JVM の Qodana コミュニティ
`qodana-jvm`	JVM 用 Qodana
`qodana-jvm-android`	Android のための Qodana コミュニティ
`qodana-android`	Android 用 Qodana
`qodana-php`	PHP 用の Qodana
`qodana-python`	Python 用 Qodana
`qodana-python-community`	Python のための Qodana コミュニティ
`qodana-js`	JS 用 Qodana
`qodana-go`	Go 用 Qodana
`qodana-dotnet`	.NET 用 Qodana
`qodana-cdnet`	.NET の Qodana コミュニティ
`qodana-cpp`	C/C++ 用 Qodana
`qodana-clang`	C/C++ のための Qodana コミュニティ
`qodana-ruby`	Ruby 用 Qodana

--within-docker <true|false>

Docker コンテナー内で分析を実行するかどうかを定義します。

true に設定した場合、Qodana は対応する Docker イメージを使用します。コンテナー作成用のイメージは、--image の値に基づいて自動的に選択されます。例: --linter qodana-jvm の場合は、jetbrains/qodana-jvm イメージが選択されます。

false に設定すると、Qodana は現在の環境を使用してネイティブモードでプロジェクトを分析します。

デフォルト値は、現在の環境とプロジェクトの分析に基づいて動的に定義されます。

ネイティブモードは現在、次の Qodana リンターで利用できます。

リンター名	説明
`qodana-jvm`	JVM 用 Qodana
`qodana-jvm-community`	JVM の Qodana コミュニティ
`qodana-php`	PHP 用の Qodana
`qodana-js`	JS 用 Qodana
`qodana-dotnet`	.NET 用 Qodana
`qodana-go`	Go 用 Qodana
`qodana-python`	Python 用 Qodana
`qodana-python-community`	Python のための Qodana コミュニティ

-i, --project-dir <string>

分析対象プロジェクトのルートディレクトリ。デフォルト値は . です

--repository-root string <string>

Git リポジトリのルートへのパス。このディレクトリは --project-dir と同じであるか、プロジェクトディレクトリを内部に含んでいる必要があります。

-o, --results-dir <string>

Qodana 分析レポートの保存先ディレクトリを上書きします。デフォルト値は <userCacheDir>/JetBrains/Qodana/<linter>/results です

--cache-dir <string>

キャッシュディレクトリを上書きします。デフォルト値は <userCacheDir>/JetBrains/Qodana/<linter>/cache です

-r, --report-dir <string>

Qodana HTML レポートを保存するディレクトリを上書きします。デフォルト値は <userCacheDir>/JetBrains/<linter>/results/report です

--print-problems

Qodana によって発見されたすべての問題を CLI 出力に印刷します

--code-climate

GitLab CI/CD でサポートされている SARIF 形式のコード気候(英語)レポートを生成します。レポートは --results-dir オプションで指定されたディレクトリに保存されます。デフォルトでは、GitLab CI/CD が実行中の場合、このオプションは有効になっています。

--bitbucket-insights

Bitbucket クラウドでサポートされているコードインサイト(英語)レポートを生成します。デフォルトでは、Qodana が Bitbucket パイプラインで実行されている場合、このオプションは有効になっています。

--clear-cache

分析を実行する前にローカル Qodana キャッシュをクリアします

-w, --show-report

--port オプションで指定されたポートで HTML レポートを提供する

--port <int>

レポートを提供するポート。デフォルト値は 8080 です。このオプションは非推奨です。代わりに --show-report-port オプションを使用してください

--show-report-port <int>

報告書を届ける港

--config <string>

qodana.yaml の代わりにカスタム構成ファイルを設定します。プロジェクトのルートディレクトリからの相対パスを使用します

-a, --analysis-id <string>

Qodana Cloud で使用される一意のレポート識別子 (GUID)。デフォルト値は 2c72b6e8-f09d-472a-bb86-8a7d8e374ed1 です

-b, --baseline <string>

ベースライン状態の計算で使用される既存の SARIF レポートへのパスを指定します

--baseline-include-absent

出力レポートに存在しないとマークされたベースラインの問題を含める

--full-history [--commit <commit-hash>]

コミット履歴全体を調べ、各コミットの分析を実行します。--commit と組み合わせると、指定されたコミットから分析が開始されます。

--commit <commit-hash> [--full-history]

Git をリセットし、指定されたコミット以降に変更されたファイルのみの分析を実行します。--full-history オプションと組み合わせると、指定されたコミットから完全な履歴分析が開始されます。

--fail-threshold <string>

品質ゲートとして機能する問題数を設定します。品質ゲートのしきい値に達すると、分析はゼロ以外の終了コードで終了します。

--disable-sanity

qodana.sanity インスペクションプロファイルで構成されたインスペクションをスキップする

-d, --source-directory <string>

分析する必要がある project-dir ディレクトリ内のディレクトリを指定します。指定しない場合は、プロジェクト全体が分析されます。

--repository-root <string>

プロジェクトの VCS ルートディレクトリを指定してください。このオプションは Git 関連の操作に必須です

--only-directory <string>

分析する必要がある project-dir ディレクトリ内のディレクトリを指定します。指定しない場合は、プロジェクト全体が分析されます。

.git や build.gradle などの外部ディレクトリに含まれるファイルとディレクトリは、コードのインスペクション中に Qodana によって使用されます。

-n, --profile-name <string>

プロファイル名を指定

-p, --profile-path <string>

プロファイルファイルへのパスを指定します

--run-promo <true|false>

プロモーションインスペクションを使用する場合はこのオプションを true に設定し、それ以外の場合は false に設定します。デフォルトプロファイルを使用して Qodana を実行する場合、デフォルト値は true です。

--script <string>

Qodana の実行シナリオをオーバーライドします。現在、次の実行シナリオが利用可能です。

シナリオ名	説明
`default`	デフォルトで有効になっているデフォルトの Qodana シナリオ
`php-migration`	PHP バージョンの移行シナリオ
`local-changes`	コミットされていない変更のみを分析します。増分分析の詳細については、増分分析セクションを参照してください。

--coverage-dir <string>

分析用のコードカバレッジデータを含むディレクトリを指定します

--apply-fixes

クリーンアップを含む利用可能なすべてのクイックフィックス戦略を適用します。詳細については、クイックフィックスセクションを参照してください。

--cleanup

CLEANUP クイックフィックス戦略を実行します。詳細についてはクイックフィックスを参照してください

--property <stringArray>

Qodana の実行中に使用する JVM プロパティを設定します。--property property.name=value1,value2,...,valueN 表記を使用します

-s, --save-report

HTML レポートを生成します。このオプションはデフォルトで有効になっています

--timeout int

Qodana 分析時間制限をミリ秒単位で設定します。制限時間に達すると分析は終了し、プロセスは timeout-exit-code コードで終了します。デフォルト設定は 1 です。

--timeout-exit-code <int>

デフォルトの timeout 設定を --timeout オプションで上書きします。timeout オプションで設定されたデフォルト値は 1 です

--diff-start <string>

変更分析で比較の基準となるコミットのハッシュを設定します。

--diff-end <string>

変更分析の終了として機能するコミットのハッシュを設定します。これにより、--diff-start コミットと --diff-end コミットの間で変更されたファイルのみを分析できます。

--reverse

デフォルトの実行シナリオを上書きして、増分分析を逆順に実行します。これにより、増分分析で問題が検出されなかった場合、メインコードベースの分析をスキップできます。

--no-statistics

匿名統計の送信を無効にする

--compile-commands <string>

compile_commands.json ファイルへのパスを指定します。デフォルト値は ./build/compile_commands.json" です

--clang-args <string>

追加の引数を設定します。詳細については C / C++ セクションを参照してください

--solution <string>

ソリューションファイルへの相対パスを設定します。詳細については、.NET セクションを参照してください。

--project <string>

プロジェクトファイルへの相対パスを設定します。詳細については .NET セクションを参照してください

--configuration <string>

ビルド構成を指定します。詳細については .NET セクションを参照してください

--platform <string>

ビルドプラットフォームを指定します。詳細については .NET セクションを参照してください

--no-build

分析の前にプロジェクトの構築をスキップします。詳細については .NET セクションを参照してください

-e, --env <stringArray>

Qodana コンテナーの環境変数を定義します。複数の変数を指定できます。セキュリティ上の理由から、Qodana CLI はホストオペレーティングシステムから環境変数を読み取らないため、Qodana に必要なすべての変数を明示的に指定する必要があります。

-v, --volume <stringArray>

Qodana コンテナーに追加のボリュームを定義します。複数のボリュームを指定できます。例: qodana scan --volume $(pwd)/.qodana/results:/data/results/

-u, --user <string>

Qodana コンテナーを実行するユーザー。ユーザー ID - $UID またはユーザー ID とグループ ID $(id -u):$(id -g) を指定してください。ルートユーザーとして実行するには、root を使用します。デフォルトでは、現在のユーザーに設定されています。

--skip-pull

最新の Qodana コンテナーのプルをスキップする

qodana scan <options> コマンドを使用して、Qodana CLI でこれらのオプションを呼び出すことができます。

分析レポートを Qodana クラウドに送信する

オプション	説明
`-a, --analysis-id <string>`	Qodana Cloud で使用される一意のレポート識別子（GUID）。デフォルト値は `f9d8a78f-f922-452b-8062-a64afc352537` です
`--config <string>`	`qodana.yaml` の代わりにカスタム構成ファイルを設定します。プロジェクトのルートディレクトリからの相対パスを使用します
`-l, --linter <string>`	Qodana Cloud に送信するレポートに使用するリンターをオーバーライドします
`-i, --project-dir <string>`	Qodana Cloud にレポートが送信されるプロジェクトのルートディレクトリ。デフォルト値は `.` です
`-r, --report-dir <string>`	Qodana HTML レポートを保存するディレクトリを上書きします。デフォルト値は `<userCacheDir>/JetBrains/<linter>/results/report` です
`-o, --results-dir <string>`	Qodana レポートの送信元となるディレクトリを上書きします。デフォルト値は `<userCacheDir>/JetBrains/<linter>/results` です

qodana send <options> コマンドを使用して、Qodana CLI でこれらのオプションを呼び出すことができます。

報告の表示

オプション	説明
`--config <string>`	`qodana.yaml` の代わりにカスタム構成ファイルを設定します。プロジェクトのルートディレクトリからの相対パスを使用します
`-d, --dir-only`	レポートディレクトリのみを開き、提供しない
`-l, --linter <string>`	表示するレポートのリンターをオーバーライドする
`-p, --port <int>`	レポートを提供するポートを指定します。デフォルト値は `8080` です
`-i, --project-dir <string>`	レポートを表示するプロジェクトのルートディレクトリ。デフォルト値は `.` です
`-r, --report-dir <string>`	Qodana HTML レポートを保存するディレクトリを上書きします。これは `index.html` ファイルを含むディレクトリです。デフォルト値は `<userCacheDir>/JetBrains/<linter>/results/report` です
`-o, --results-dir <string>`	分析レポートの保存先ディレクトリを上書きします。デフォルト値は `<userCacheDir>/JetBrains/<linter>/results` です

qodana show <options> コマンドを使用して、Qodana CLI でこれらのオプションを呼び出すことができます。

SARIF 形式のファイルを表示する

オプション	説明	デフォルト設定
`-f, --sarif-file <string>`	SARIF 形式のファイルへのパス	`./qodana.sarif.json`

qodana view <options> コマンドを使用して、Qodana CLI でこれらのオプションを呼び出すことができます。

コントリビューターの数を数える

プロジェクトへのコントリビューターに関する情報を収集するには、次のオプションを使用して Qodana を実行できます。

オプション	説明	デフォルト設定
`-d, --days <int>`	アクティブなコントリビューターの数を計算するために使用する過去の日数	90
`-o, --output string`	出力形式。使用可能な値は `tabular` と `json` です	`tabular`
`-i, --project-dir <stringArray>`	複数のプロジェクトを分析するために複数回指定できるプロジェクトディレクトリ	`.`

qodana contributors <options> コマンドを使用して、Qodana CLI でこれらのオプションを呼び出すことができます。

プロジェクトの統計情報を表示

これらのオプションを使用すると、言語やコード行などのプロジェクトに関する情報を表示できます。

オプション	説明
`-o, --output <string>`	`tabular`、`wide`、`json`、`csv`、`csv-stream`、`cloc-yaml`、`html`、`html-table`、`sql`、`sql-insert`、`openmetrics` 値を受け入れる出力形式。デフォルト設定は `tabular` です
`-i, --project-dir <stringArray>`	プロジェクトディレクトリ。このオプションは複数回指定することで、複数のプロジェクトを分析できます。指定しない場合は、現在のディレクトリが使用されます。

qodana cloc <options> コマンドを使用して、Qodana CLI でこれらのオプションを呼び出すことができます。

Qodana イメージをプルする

これらのオプションを使用すると、使用したい Qodana リンターをプルできます。

オプション	説明
`--config <string>`	`qodana.yaml` の代わりにカスタム構成ファイルを設定します。プロジェクトのルートディレクトリからの相対パスを使用します
`--image <string>`	取得したいイメージを指定します
`-l` , `--linter <string>`	取得したいリンターを指定します
`-i` , `--project-dir <string>`	分析対象プロジェクトのルートディレクトリ。指定しない場合は、現在のディレクトリが使用されます。

これらのオプションは、Qodana CLI の qodana pull <options> コマンドを使用して呼び出すことができます。Qodana CLI は、 qodana.yaml ファイル設定または --linter オプションを使用してリンターに関する情報を取得します。

自動補完スクリプトを生成する

これらのオプションを使用すると、特定のシェルの自動補完スクリプトを生成できます。

コマンド	説明
`bash`	bash の自動補完スクリプトを生成する
`fish`	魚の自動補完スクリプトを生成する
`powershell`	PowerShell の自動補完スクリプトを生成する
`zsh`	zsh の自動補完スクリプトを生成する

qodana completion <options> コマンドを使用して、Qodana CLI でこれらのオプションを呼び出すことができます。

ログレベルの設定とアップデートの確認

オプション	説明
`--disable-update-checks`	Qodana CLI の新しいバージョンに関するチェックと通知を無効にする
`--log-level <string>`	Qodana CLI の出力のログレベルを変更します。例: `--log-level debug` を設定すると、詳細なログレポートを受信できます。デフォルト設定は `error` です。

2026 年 10 月 02 日

Qodana 2026.2 ヘルプ