CodeQL の構成ファイルでコマンド オプションを指定する

頻繁に使用されるコマンド オプションとカスタム CodeQL パックを CodeQL 構成ファイルに追加することで、時間を節約できます。

この機能を使用できるユーザーについて

CodeQL は、次の種類のリポジトリで使用できます:

          CodeQL構成ファイルの使用

1. config サブディレクトリのホーム (Linux および macOS) ディレクトリまたはユーザー プロファイル (Windows) ディレクトリに、.config/codeql/ ファイルを作成して保存します。 たとえば、「 $HOME/.config/codeql/config 」のように入力します。 1. config ファイルで、CodeQL コマンドに適用するオプションを指定します。 オプションを指定する構文は次のとおりです。

```shell
<command> <subcommand> <option> <value>
```

  1. 同じオプションを複数のコマンドに適用するには、次の手順を実行します。

    •     `<subcommand>`を省略すると、関連するすべてのオプションが指定されます。`<subcommand>`

    •     `<command>`と`<subcommand>`の両方を省略すると、このオプションは関連するすべての`<command>`および`<subcommand>`に対してグローバルに指定されます。

メモ

* config ファイルは、オプション フラグと値の間に、 =ではなくスペースのみを受け入れます。

  • コマンド ラインでオプションを指定すると、そのオプションに対して定義されているすべての config 値がオーバーライドされます。
          `<command>`、`<subcommand>`、またはグローバルに複数のオプションを指定するには、オプションごとに 1 行を使用します。

例示

  •         `codeql database analyze` によって生成されたすべての分析結果を CSV 形式で出力するには、次のように指定します。

    database analyze --format csv

    ここでは、database analyze の間に実行される低レベルのコマンドに同じ --format オプションが渡されるのを防ぐため、コマンドとサブコマンドを指定する必要があります。

  •         CodeQLコマンドの実行時に使用する RAM (4096 MB) とスレッド数 (4) を定義するには、次を別々の行に指定します。

    --ram 4096
--threads 4

  • (インストール ディレクトリの兄弟ではない) CodeQL パックをスキャンするCodeQLのディレクトリをグローバルに指定するには、次の値を使用します。

    --search-path <path-to-directory>