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

В этой статье

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

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

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

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

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

Краткий обзор

Shell

codeql pack download [--dir=<dir>] [--force] <options>... -- <scope/name[@version]|suite.qls>...

codeql pack download [--dir=<dir>] [--force] <options>... -- <scope/name[@version]|suite.qls>...

Описание

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

Пакеты будут загружены и распакуются в кэш пакетов по умолчанию.

Доступно начиная с v2.6.0.

Основные параметры

`<scope/name[@version]|suite.qls>...`

[Обязательно] Список пакетов CodeQL и наборов запросов для скачивания. Если предоставляется набор запросов, будут проверены его инструкции и скачиваются все указанные пакеты CodeQL. Если не указать версию для пакета CodeQL, будет загружена последняя версия.

`--format=<fmt>`

Выберите формат вывода (textпо умолчанию) или json.

`-d, --dir=<dir>`

Каталог, в который нужно скачать пакет. По умолчанию устанавливается в кэш пакетов.

`--for-pack=<pack>`

Пакет, зависимости которого скачиваются. Реестр пакетов для каждого пакета будет определяться свойством registries объекта \.

`--[no-]allow-prerelease`

Разрешить использование пакетов с квалификаторами предварительной версии (например, X.Y.Z-qualifier). Без этого флага пакеты предварительной версии будут игнорироваться.

Доступно начиная с v2.11.3.

`-f, --[no-]force`

Разрешить перезапись уже существующих пакетов.

Параметры для поиска пакетов QL (которые могут потребоваться для интерпретации наборов запросов)

`--search-path=<dir>[:<dir>...]`

Список каталогов, в которых можно найти пакеты QL. Каждый каталог может быть либо пакетом QL (или пакетом пакетов, .codeqlmanifest.json содержащим файл в корне), либо непосредственным родительским элементом одного или нескольких таких каталогов.

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

Указание на это при извлечении репозитория CodeQL с открытым кодом должно работать при запросе одного из языков, которые там живут.

Если вы извлекли репозиторий CodeQL как одноуровневый элемент неупакованной цепочки инструментов CodeQL, вам не нужно предоставлять этот параметр. в таких одноуровневых каталогах всегда будет выполняться поиск пакетов QL, которые не могут быть найдены в противном случае. (Если это значение по умолчанию не работает, настоятельно рекомендуется настроить --search-path один раз и для всех в файле конфигурации для каждого пользователя.

(Примечание. В Windows разделителем пути является ;).

`--additional-packs=<dir>[:<dir>...]`

Если указан этот список каталогов, в них будет выполняться поиск пакетов перед каталогами в --search-path. Порядок между ними не имеет значения; Это ошибка, если имя пакета найдено в двух разных местах в этом списке.

Это полезно, если вы временно разрабатываете новую версию пакета, которая также отображается в пути по умолчанию. С другой стороны, не рекомендуется переопределять этот параметр в файле конфигурации; некоторые внутренние действия добавляют этот параметр на лету, переопределяя любое настроенное значение.

(Примечание. В Windows разделителем пути является ;).

Параметры настройки диспетчера пакетов CodeQL

`--registries-auth-stdin`

Выполните проверку подлинности в реестрах контейнеров GitHub Enterprise Server, передав список \<registry_url>=\ пар, разделенный запятыми.

Например, можно передать https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2 для проверки подлинности в двух экземплярах GitHub Enterprise Server.

Это переопределяет переменные среды CODEQL_REGISTRIES_AUTH и GITHUB_TOKEN. Если вам нужно пройти проверку подлинности только в реестре контейнеров github.com, можно использовать более --github-auth-stdin простой вариант.

`--github-auth-stdin`

Выполните проверку подлинности в реестре контейнеров github.com, передав github.com маркер GitHub Apps или личный маркер доступа через стандартные входные данные.

Чтобы пройти проверку подлинности в реестрах контейнеров GitHub Enterprise Server, передайте --registries-auth-stdin или используйте переменную среды CODEQL_REGISTRIES_AUTH.

Это переопределяет переменную среды GITHUB_TOKEN.