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

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

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

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

  • GitHub.com のパブリック リポジトリについては、「GitHub CodeQL の使用条件」を参照してください
  • GitHub Code Security が有効になっている GitHub Team または GitHub Enterprise Cloud 上の organization 所有のリポジトリ

CodeQL の構成ファイルを使用する

  1.        `config` サブディレクトリのホーム (Linux および macOS) ディレクトリまたはユーザー プロファイル (Windows) ディレクトリに、`.config/codeql/` ファイルを作成して保存します。 たとえば、「 `$HOME/.config/codeql/config` 」のように入力します。

  2.        `config` ファイルで、CodeQL コマンドに適用するオプションを指定します。 オプションを指定する構文は次のとおりです。

    <command> <subcommand> <option> <value>

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

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

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

メモ

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

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

例示

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

    database analyze --format csv

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

  • CodeQL コマンドの実行時に使う RAM (4,096 MB) とスレッド数 (4) を定義するには、個別の行で以下を指定します。

    --ram 4096
--threads 4

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

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