The Wayback Machine - https://web.archive.org/web/20230128151520/https://docs.github.com/ru/enterprise-cloud@latest/code-security/code-scanning/using-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file
Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.
 

 

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

In this article

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

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

Если у вас есть учетная запись GitHub Enterprise и лицензия на 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> из них, к которому он относится.
  • Опустите и <command> <subcommand>, чтобы глобально задать параметр для каждого <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>