Примечание: Эта статья была перенесена с веб-сайта документации CodeQL в январе 2023 г.
Сведения о CodeQL CLI
Разработчики программного обеспечения и исследователи безопасности могут защитить свой код с помощью CodeQL CLI.
CodeQL CLI — это программа командной строки, используемая для локального выполнения процессов CodeQL в открытый код проектах программного обеспечения. CodeQL CLI можно использовать для следующих способов:
- Выполнение анализа CodeQL с помощью запросов, предоставленных инженерами GitHub и сообществом открытый код
- Создание баз данных CodeQL для использования в CodeQL для Visual Studio Code
- Разработка и тестирование пользовательских запросов CodeQL для использования в собственных анализах
Сведения об использовании CodeQL CLI см. в разделе Начало работы с CodeQL CLI.
Вы также можете использовать конвейеры GitHub Actions или Azure DevOps для сканирования кода с помощью CodeQL CLI. Дополнительные сведения см. в разделе Настройка проверки кода для репозитория или Настройка GitHub Advanced Security for Azure DevOps в Microsoft Learn.
Сведения о лицензии GitHub CodeQL
Уведомление о лицензии: Если у вас нет лицензии на GitHub Enterprise, устанавливая этот продукт, вы соглашаетесь с условиями GitHub CodeQL.
GitHub CodeQL лицензируется для каждого пользователя. В соответствии с ограничениями лицензии вы можете использовать CodeQL для выполнения следующих задач:
- Для выполнения академических исследований.
- Для демонстрации программного обеспечения.
- Чтобы протестировать запросы CodeQL, выпущенные в соответствии с лицензией, утвержденной OSI, чтобы убедиться, что новые версии этих запросов продолжают находить нужные уязвимости.
Где "утвержденная OSI лицензия" означает одобренную инициативой по открытому коду (OSI) открытый код лицензию на программное обеспечение.
Если вы работаете с базой кода с открытым кодом (то есть с базой кода, выпущенной в соответствии с лицензией, утвержденной OSI), вы также можете использовать CodeQL для выполнения следующих задач:
- Выполнение анализа базы кода с открытым исходным кодом.
- Если база кода с открытым исходным кодом размещается и поддерживается в GitHub.com, необходимо создать базы данных CodeQL для или во время автоматического анализа, непрерывной интеграции или непрерывной поставки.
CodeQL нельзя использовать для автоматического анализа, непрерывной интеграции или непрерывной поставки, будь то в рамках обычных процессов разработки программного обеспечения или иным образом, за исключением случаев, изложенных в настоящем документе. Для этого обратитесь в группу продаж.
Команды CodeQL CLI
CodeQL CLI включает команды для создания и анализа баз данных CodeQL из командной строки. Чтобы выполнить команду, используйте следующую команду:
codeql [command] [subcommand]
Чтобы просмотреть справочную документацию по команде, добавьте --help
флаг или см. раздел Руководство по командам CodeQL CLI.