Skip to main content
Мы публикуем частые обновления нашей документации, и перевод этой страницы может все еще выполняться. Актуальные сведения см. в документации на английском языке.

Поддержка этой версии GitHub Enterprise была прекращена 2023-03-15. Исправления выпускаться не будут даже при критических проблемах безопасности. Для повышения производительности, укрепления безопасности и новых функций установите последнюю версию GitHub Enterprise. Чтобы получить справку по обновлению, обратитесь в службу поддержки GitHub Enterprise.

Руководство по командам CodeQL CLI

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

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

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

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

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

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

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

  • bqrs diff

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

  • bqrs hash

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

  • Сведения о bqrs

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

  • bqrs interpret

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

  • database add-diagnostic

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

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

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

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

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

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

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

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

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

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

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

  • завершение работы с базой данных

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

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

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

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

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

  • database init

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

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

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

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

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

  • выполнение запросов базы данных

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

  • команда трассировки базы данных

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

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

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

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

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

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

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

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

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

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

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

  • мера набора данных

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

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

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

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

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

  • диагностический экспорт

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

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

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

  • execute language-server

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

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

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

  • execute query-server

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

  • execute query-server2

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

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

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

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

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

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

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

  • github upload-results

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

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

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

  • пакет pack

    [Экспериментальный][Сантехника] Пакет библиотеки QL.

  • pack ci

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

  • создание пакета

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

  • загрузка пакета

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

  • pack init

    [Экспериментальный] Инициализирует qlpack в указанном каталоге.

  • установка пакета

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

  • pack ls

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

  • pack packlist

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

  • публикация pack

    [Экспериментальный] Публикует пакет библиотеки QL в реестре пакетов.

  • pack resolve-dependencies

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

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

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

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

    Компилируйте или проверка код QL.

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

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

  • формат запроса

    Автоформат исходного кода QL.

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

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

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

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

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

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

  • resolve extensions-by-pack

    [Experimental][Deep plumbing] Determine accessible extensions for the given paths to pack roots. This includes machine learning models and data extensions.

  • resolve extractor

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

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

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

  • разрешить языки

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

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

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

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

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

  • resolve ml-models

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

  • resolve qlpacks

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

  • resolve qlref

    [Глубокая сантехника] Разыменовка QLREF-файла возвращает QL-файл.

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

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

  • разрешение ОЗУ

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

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

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

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

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

  • принять тест

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

  • тестовое извлечение

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

  • тестовый запуск

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

  • version

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