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

В этой статье

Параметры команд по умолчанию можно сохранить в файле конфигурации CodeQL.

GitHub CodeQL лицензируется для каждого пользователя после установки. CodeQL можно использовать только для определенных задач с ограничениями лицензии. Дополнительные сведения см. в разделе Сведения о CodeQL CLI.

Если у вас есть лицензия на GitHub Advanced Security, вы можете использовать CodeQL для автоматического анализа, непрерывной интеграции и непрерывной поставки. Дополнительные сведения см. в разделе Сведения о GitHub Advanced Security.

Примечание: Эта статья была перенесена с веб-сайта документации CodeQL в январе 2023 г.

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

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

Параметры команды CodeQL CLI можно указать двумя способами:

Непосредственно в командной строке, используя соответствующий флаг.
В файле конфигурации (или config), который CodeQL проверяет соответствующие параметры при каждом выполнении команды.

Для параметров, которые могут изменяться при каждом выполнении команды, указание значения в командной строке является наиболее удобным способом передачи информации в CodeQL. Сохранение параметров в config файле — хороший способ указать часто используемые параметры. Это также хороший способ добавления пользовательских пакетов CodeQL, которые вы регулярно используете в пути поиска.

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

Необходимо сохранить файл в домашнем каталоге config (Linux и macOS) или в каталоге профиля пользователя (Windows) в подкаталоге .config/codeql/ . Например, $HOME/.config/codeql/config.

Синтаксис для указания параметров выглядит следующим образом:

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

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

Опустите <subcommand>параметр , в котором будет указан параметр для каждого <subcommand> , к которому он относится.
Опустите и <subcommand>``<command> , чтобы глобально указать параметр для всех <command> и <subcommand> , к которым он относится.

Примечания.

config Файлы принимают пробелы только между флагами параметров и значениями. CodeQL выдает ошибку, если вы используете = для указания значения параметра.
Если указать параметр в командной строке, это переопределяет значение, определенное 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>
```