Примечание: Эта статья была перенесена с веб-сайта документации CodeQL в январе 2023 г.
Сведения о CodeQL CLI
Разработчики программного обеспечения и исследователи по безопасности могут защитить свой код с помощью CodeQL CLI.
CodeQL CLI — это программа командной строки, используемая для локального выполнения процессов CodeQL в открытый код проектах программного обеспечения. CodeQL CLI можно использовать для:
- Выполнение анализа CodeQL с помощью запросов, предоставленных инженерами GitHub и сообществом открытый код
- Создание баз данных CodeQL для использования в CodeQL для Visual Studio Code
- Разработка и тестирование пользовательских запросов CodeQL для использования в собственных анализах
Сведения об использовании CodeQL CLI см. в разделе Начало работы с CodeQL CLI.
Сведения о лицензии 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.