在 CodeQL 配置文件中指定命令选项

通过将您常用的命令选项和自定义的 CodeQL 包添加到 CodeQL 配置文件中来节省时间。

谁可以使用此功能？

CodeQL 可用于以下存储库类型：

使用 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> 或全局指定多个选项，请为每个选项使用单独一行。

例子

  • 若要以 CSV 格式输出由 codeql database analyze 生成的所有分析结果，需要指定以下内容：

    database analyze --format csv

    在这里，必须指定命令和子命令，以防止在 database analyze 期间执行的任何低级命令被传递相同的 --format 选项。

  • 若要定义运行 CodeQL 命令时要使用的 RAM (4096 MB) 和线程数 (4)，请在单独的行中指定以下内容：

    --ram 4096
--threads 4

  • 若要全局指定 CodeQL 的目录以扫描 CodeQL 包（它不是安装目录的同级），请使用：

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