Указание параметров команды в файле конфигурации 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>, или глобально, используйте одну строку на каждый вариант.

Примеры

  • Чтобы вывести все результаты анализа, созданные codeql database analyze в формате CSV, необходимо указать следующее:

    database analyze --format csv

    Здесь необходимо указать команду и подкоманда, чтобы предотвратить выполнение любой из низкоуровневых команд, выполняемых во время database analyze прохождения того же --format параметра.

  • Чтобы определить ОЗУ (4096 МБ) и количество потоков (4) для использования при выполнении команд CodeQL укажите следующее в отдельных строках:

    --ram 4096
--threads 4

  • Чтобы глобально указать каталог для CodeQL для сканирования пакетов CodeQL (который не является братом каталога установки), используйте следующую команду:

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