Skip to main content

Команды CLI CodeQL вручную

Справочные сведения о командах, доступных в последнем выпуске CodeQL CLI.

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

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

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

Это содержимое описывает последний выпуск данных CodeQL CLI. Дополнительные сведения об этом выпуске см. в статье https://github.com/github/codeql-cli-binaries/releases.

Чтобы просмотреть сведения о параметрах, доступных для этой команды в предыдущем выпуске, выполните команду с --help параметром в терминале.

декодирование bqrs

Преобразуйте данные результатов из BQRS в другие формы.

bqrs diff

Вычислить разницу между двумя результирующих наборами.

хэш bqrs

[Сантехника] Вычислите стабильный хэш файла BQRS.

сведения о bqrs

Отображение метаданных для BQRS-файла.

Bqrs интерпретирует

[Сантехника] Интерпретация данных в одном BQRS.

диагностика надстроек базы данных

[Экспериментальный] Добавьте в базу данных часть диагностических сведений.

анализ базы данных

Анализ базы данных, создание значимых результатов в контексте исходного кода.

пакет базы данных

Создайте перемещаемый архив базы данных CodeQL.

Очистка базы данных

Сжатие базы данных CodeQL на диске.

создание базы данных

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

диагностика экспорта базы данных

[Экспериментальный] Экспорт диагностических сведений из базы данных для неудачного анализа.

Завершение работы базы данных

[Сантехника] Заключительные шаги по созданию базы данных.

импорт базы данных

[Дополнительно] [Сантехника] Импортируйте неопределенные базы данных в другую неопределенную базу данных.

файлы индекса базы данных

[Сантехника] Индексируйте автономные файлы с помощью заданного средства извлечения CodeQL.

инициализация базы данных

[Сантехника] Создайте пустую базу данных CodeQL.

результаты интерпретации базы данных

[Сантехника] Интерпретируйте результаты вычисляемого запроса в значимые форматы, такие как SARIF или CSV.

базовые показатели печати базы данных

[Сантехника] Напечатайте сводку по базовым строкам кода.

запросы запуска базы данных

[Сантехника] Выполните набор запросов вместе.

команда trace-command базы данных

[Сантехника] Выполните одну команду в рамках трассировки сборки.

отмена подключения к базе данных

Извлекает архив базы данных CodeQL.

обновление базы данных

Обновите базу данных, чтобы она была доступна для использования текущими средствами.

проверка набора данных

[Сантехника] Проверьте определенный набор данных для обеспечения внутренней согласованности.

Очистка набора данных

[Сантехника] Очистка временных файлов из набора данных.

Импорт набора данных

[Сантехника] Импортируйте набор файлов TRAP в необработанный набор данных.

Мера набора данных

[Сантехника] Сбор статистики о отношениях в определенном наборе данных.

Обновление набора данных

[Сантехника] Обновите набор данных, чтобы он можно было использовать с помощью текущих средств.

добавление диагностики

[Экспериментальный] [Сантехника] Добавьте часть диагностических сведений.

экспорт диагностики

[Экспериментальный] Экспорт диагностических сведений для неудачного анализа.

выполнение cli-server

[Глубокая сантехника] Сервер для выполнения нескольких команд, избегая повторяющейся инициализации JVM.

выполнение языка-сервера

[Сантехника] Встроенная поддержка языка QL в idEs.

выполнение запросов

[Сантехника] Выполните один или несколько запросов к набору данных.

выполнение запроса-сервера

[Сантехника] Поддержка выполнения запросов из удостоверений.

выполнение запроса-server2

[Сантехника] Поддержка выполнения запросов из удостоверений.

Выполнение обновлений

[Сантехника] Запустите скрипты обновления в существующем необработанном наборе данных QL.

создание расширяемых-предикат-метаданных

[Экспериментальный] [Глубокая сантехника] Сообщите расширяемые предикаты, найденные в указанном пакете.

создание сводки по журналам

[Дополнительно] Создайте сводку структурированного файла журнала.

создание справки по запросу

Создайте справку по запросу конечных пользователей из Qhelp-файлов.

github merge-results

[Глубокая сантехника] Объединяет несколько ФАЙЛОВ SARIF в один ФАЙЛ SARIF.

github upload-results

Отправляет ФАЙЛ SARIF в сканирование кода GitHub.

Добавление пакета

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

пакет пакетов

[Сантехника] Упаковайте пакет библиотеки QL.

pack ci

Установите зависимости для этого пакета, убедившись, что существующий файл блокировки обновлен.

Создание пакета

[Сантехника] Создает содержимое пакета QL из исходного кода.

Скачивание пакета

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

пакет инициализации

Инициализирует qlpack в указанном каталоге.

Установка пакета

Установите зависимости для этого пакета.

pack ls

[Глубокая сантехника] Список пакетов CodeQL, корневых в этом каталоге. Этот каталог должен содержать файл qlpack.yml или .codeqlmanifest.json.

список пакетов

[Сантехника] Вычислить набор файлов, включенных в пакет запросов QL или пакет библиотеки.

публикация пакета

Публикует пакет библиотеки QL в реестре пакетов.

пакеты resolve-dependencies

[Сантехника] Вычислить набор необходимых зависимостей для этого пакета QL.

обновление пакета

Обновите зависимости для этого пакета до последних доступных версий.

компиляция запросов

Скомпилируйте или проверьте код QL.

декомпиляция запроса

[Сантехника] Чтение промежуточного представления скомпилированного запроса из QLO-файла.

Формат запроса

Исходный код автоформата QL.

выполнение запроса

Выполните один запрос.

разрешение базы данных

[Глубокая сантехника] Сообщите метаданные о базе данных.

разрешение расширений

[Экспериментальный] [Глубокая сантехника] Определите расширения со специальными возможностями. К ним относятся модели машинного обучения и расширения данных.

разрешение расширений по пакету

[Экспериментальный] [Глубокая сантехника] Определите доступные расширения для заданных путей для упаковки корней. К ним относятся модели машинного обучения и расширения данных.

разрешение средства извлечения

[Глубокая сантехника] Определите пакет средства извлечения, используемый для данного языка.

разрешение файлов

[Глубокая сантехника] Разверните набор глобов включения и исключения файлов.

Разрешение языков

Вывод списка установленных пакетов средств извлечения CodeQL.

разрешение пути к библиотеке

[Глубокая сантехника] Определите путь библиотеки QL и dbscheme для запроса.

разрешение метаданных

[Глубокая сантехника] Разрешайте и возвращайте пары метаданных "ключ-значение" из исходного файла запроса.

разрешение моделей машинного обучения

[Не рекомендуется] [Экспериментальный] [Глубокая сантехника] Определение доступных моделей машинного обучения.

разрешение пакетов

Отображение списка доступных пакетов CodeQL и их расположений.

разрешение qlpacks

Создайте список установленных пакетов QL и их расположения.

разрешение qlref

[Глубокая сантехника] Расшифровка файла .qlref для возврата QL-файла.

разрешение запросов

[Глубокая сантехника] Разверните каталоги запросов и спецификации набора.

разрешение озу

[Глубокая сантехника] Подготовка параметров ОЗУ.

разрешение тестов

[Глубокая сантехника] Найдите модульные тесты QL в указанных каталогах.

Разрешение обновлений

[Глубокая сантехника] Определите обновления для необработанного набора данных.

проверка принятия

Примите результаты неудачных модульных тестов.

извлечение теста

[Сантехника] Создайте набор данных для тестового каталога.

тестовое выполнение

Запустите модульные тесты для запросов QL.

версия

Отображение версии цепочки инструментов CodeQL.