{"meta":{"title":"создание справки по запросу","intro":"Создайте справку по запросу конечных пользователей из Qhelp-файлов.","product":"Безопасность и качество кода","breadcrumbs":[{"href":"/ru/code-security","title":"Безопасность и качество кода"},{"href":"/ru/code-security/reference","title":"Reference"},{"href":"/ru/code-security/reference/code-scanning","title":"Проверка кода"},{"href":"/ru/code-security/reference/code-scanning/codeql","title":"CodeQL"},{"href":"/ru/code-security/reference/code-scanning/codeql/codeql-cli-manual","title":"Руководство по cli CodeQL"},{"href":"/ru/code-security/reference/code-scanning/codeql/codeql-cli-manual/generate-query-help","title":"создание справки по запросу"}],"documentType":"article"},"body":"# создание справки по запросу\n\nСоздайте справку по запросу конечных пользователей из Qhelp-файлов.\n\n> [!NOTE]\n> Это содержимое описывает последний выпуск данных CodeQL CLI. Дополнительные сведения об этом выпуске см. в статье https://github.com/github/codeql-cli-binaries/releases.\n>\n> Чтобы просмотреть сведения о параметрах, доступных для этой команды в предыдущем выпуске, выполните команду с <span style=\"white-space: nowrap;\">`--help`</span> параметром в терминале.\n\n## Synopsis\n\n```shell copy\ncodeql generate query-help --format=<format> [--output=<dir|file>] <options>... -- <qhelp|mdhelp|query|dir|suite>...\n```\n\n## Description\n\nСоздайте справку по запросу конечных пользователей из Qhelp-файлов.\n\n## Options\n\n### Основные параметры\n\n#### `<qhelp|mdhelp|query|dir|suite>...`\n\n              \\[Обязательный] Запрос справки по файлам для отрисовки. Каждый аргумент является одним из следующих:\n\n* Qhelp-файл для отрисовки.\n* Md-файл для отрисовки.\n* QL-файл с соответствующим Qhelp или MD-файлом для отрисовки.\n* Каталог, который будет искать рекурсивно для QL-файлов с соответствующими Qhelp или MD-файлами.\n* QLS-файл, определяющий определенный набор запросов.\n* Базовое имя файла QLS, экспортированного одним из установленных пакетов QL.\n\n#### `--format=<format>`\n\n              \\[Обязательный] Формат, в котором выполняется отрисовка документации. Одно из:\n\n              `markdown`: GitHub с ароматизированным markdown.\n\n              `sarif-latest`: формат обмена статическими результатами анализа (SARIF), формат на основе JSON для описания результатов статического анализа. Этот параметр формата использует последнюю поддерживаемую версию (версии 2.1.0). Этот параметр не подходит для использования в автоматизации, так как он создает разные версии SARIF между различными версиями CodeQL.\n\n              `sarifv2.1.0`: SARIF версии 2.1.0.\n\n#### `-o, --output=<dir|file>`\n\nПуть для записи отображаемой документации. Обычно это каталог, в который будут записываться отрисованные выходные данные.\n\nЕсли предоставляется только один Qhelp или QL-файл, а каталог не существует в пути вывода, выходные данные записываются в один файл по указанному пути.\n\nЕсли выходной путь не указан, будет принят только один Qhelp или QL-файл, и выходные данные записываются в stdout.\n\nЕсли используется выходной каталог, имена _файлов в_ выходном каталоге будут производными от имен Qhelp-файлов.\n\n#### `--warnings=<mode>`\n\nОбработка предупреждений от отрисовщика справки по запросу. Одно из:\n\n              `hide`: подавление предупреждений.\n\n              `show`\n              _(по умолчанию)_: вывод предупреждений, но продолжение отрисовки.\n\n              `error`: обрабатывает предупреждения как ошибки.\n\n#### `--no-sarif-minify`\n\n              \\[Только форматы SARIF] Создание довольно печатных выходных данных SARIF. По умолчанию выходные данные SARIF минимируются, чтобы уменьшить размер выходного файла.\n\n### Параметры поиска пакетов QL (которые могут потребоваться для разрешения наборов запросов)\n\n#### `--search-path=<dir>[:<dir>...]`\n\nСписок каталогов, в которых можно найти пакеты QL. Каждый каталог может быть пакетом QL (или пакетом пакетов, содержащих `.codeqlmanifest.json` файл в корневом каталоге) или непосредственным родительским элементом одного или нескольких таких каталогов.\n\nЕсли путь содержит несколько каталогов, их порядок определяет приоритет между ними: когда имя пакета, которое должно быть разрешено, совпадает с несколькими деревьями каталогов, то один из первых побед.\n\nУказывая это на получение репозитория CodeQL с открытым исходным кодом, должно работать при запросе одного из языков, которые живут там.\n\nЕсли вы проверили репозиторий CodeQL как одноуровневую цепочку инструментов CodeQL, вам не нужно предоставлять этот параметр; Такие каталоги с братом всегда будут искать пакеты QL, которые не удается найти в противном случае. (Если это значение по умолчанию не работает, настоятельно рекомендуется настроить `--search-path` один раз и для всех в файле конфигурации для каждого пользователя).\n\n(Примечание. В Windows разделитель путей имеет значение `;`).\n\n#### `--additional-packs=<dir>[:<dir>...]`\n\nЕсли указан этот список каталогов, они будут искать пакеты до тех, в которых они есть `--search-path`. Порядок между ними не имеет значения; Это ошибка, если имя пакета найдено в двух разных местах в этом списке.\n\nЭто полезно, если вы временно разрабатываете новую версию пакета, который также отображается в пути по умолчанию. С другой стороны, _не рекомендуется_ переопределить этот параметр в файле конфигурации. Некоторые внутренние действия будут добавлять этот параметр на лету, переопределяя любое настроенное значение.\n\n(Примечание. В Windows разделитель путей имеет значение `;`).\n\n### Параметры настройки диспетчера пакетов CodeQL\n\n#### `--registries-auth-stdin`\n\nПроверка подлинности в реестрах контейнеров GitHub Enterprise Server путем передачи \\<registry\\_url>=\\<token> разделенного запятыми списка пар.\n\nНапример, можно передать `https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2`\nдля проверки подлинности на двух экземплярах GitHub Enterprise Server.\n\nПри этом переопределяются переменные среды маркера токена CODEQL\\_И\\_AUTH и GITHUB\\_. Если вам нужно выполнить проверку подлинности только в реестре контейнеров github.com, можно вместо этого выполнить проверку подлинности с помощью более `--github-auth-stdin` простого параметра.\n\n#### `--github-auth-stdin`\n\nПроверка подлинности в реестре контейнеров github.com путем передачи маркера github.com GitHub Apps или личного маркера доступа через стандартные входные данные.\n\nЧтобы пройти проверку подлинности в реестрах контейнеров GitHub Enterprise Server, передайте `--registries-auth-stdin` или используйте переменную среды AUTH CODEQL\\_REGISTRIES\\_.\n\nЭто переопределяет переменную среды токена GITHUB\\_.\n\n### Распространенные параметры\n\n#### `-h, --help`\n\nОтображение этого текста справки.\n\n#### `-J=<opt>`\n\n              \\[Дополнительно] Укажите параметр JVM, выполняя команду.\n\n(Убедитесь, что параметры, содержащие пробелы, не будут обрабатываться правильно.)\n\n#### `-v, --verbose`\n\nПостепенно увеличьте число отображаемых сообщений о ходе выполнения.\n\n#### `-q, --quiet`\n\nПостепенно уменьшайте количество отображаемых сообщений о ходе выполнения.\n\n#### `--verbosity=<level>`\n\n              \\[Дополнительно] Явным образом задайте уровень детализации на одну из ошибок, предупреждений, хода выполнения, хода выполнения+, хода выполнения++, хода выполнения+++. Переопределяет `-v` и `-q`.\n\n#### `--logdir=<dir>`\n\n              \\[Дополнительно] Запись подробных журналов в один или несколько файлов в указанном каталоге с созданными именами, включающими метки времени и имя выполняющегося подкоманда.\n\n(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого предоставьте `--log-to-stderr` и перенаправите stderr по мере необходимости.)\n\n#### `--common-caches=<dir>`\n\n              \\[Дополнительно] Управляет расположением кэшированных данных на диске, которые будут сохраняться между несколькими запусками интерфейса командной строки, такими как скачанные пакеты QL и скомпилированные планы запросов. Если этот параметр не задан явным образом, по умолчанию используется каталог с именем `.codeql` в домашнем каталоге пользователя; он будет создан, если он еще не существует.\n\nДоступно с момента `v2.15.2`."}