Указание параметров команды в файле конфигурации CodeQL

Сэкономьте время, добавив часто используемые командные опции и пользовательские CodeQL пакеты в конфигурационный файл CodeQL.

Кто может использовать эту функцию?

CodeQL доступен для следующих типов репозитория:

Использование файла конфигурации CodeQL

  1. Создайте и сохраните файл config в вашей домашней (Linux и macOS) или профиле пользователя (#REF!) в подкаталоге .config/codeql/. Например: .

  2. В файле укажите опции, которые хотите применить к командам CodeQL. Синтаксис для указания параметров выглядит следующим образом:

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

  3. Чтобы применить одни и те же опции к нескольким командам, вы можете:

    • Опустить , что укажет опцию для каждого релевантного
    • Опустите оба варианта и , которые глобально укажут опцию для всех релевантных и

Примечание.

  • Файлы принимают только пробелы, а не , между флагами опций и значениями.
  • Указание опции в командной строке переопределяет любое значение, определённое для этой опции.
  • Чтобы указать более одного варианта для , , или глобально, используйте одну строку на каждый вариант.

Примеры

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

    database analyze --format csv

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

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

    --ram 4096
--threads 4

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

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