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

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

> [!NOTE]
> Это содержимое описывает последний выпуск данных CodeQL CLI. Дополнительные сведения об этом выпуске см. в статье https://github.com/github/codeql-cli-binaries/releases.
>
> Чтобы просмотреть сведения о параметрах, доступных для этой команды в предыдущем выпуске, выполните команду с <span style="white-space: nowrap;">`--help`</span> параметром в терминале.

## Synopsis

```shell copy
codeql diagnostic export --format=<format> [--output=<output>] <options>...
```

## Description

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

Доступно с момента `v2.12.6`.

## Options

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

#### `--format=<format>`

              \[Обязательный] Формат, в котором нужно записать результаты. Одно из:

              `raw`: список необработанных и непретируемых диагностических сообщений в виде объектов JSON.

              `sarif-latest`: формат обмена статическими результатами анализа (SARIF), формат на основе JSON для описания результатов статического анализа. Этот параметр формата использует последнюю поддерживаемую версию (версии 2.1.0). Этот параметр не подходит для использования в автоматизации, так как он создает разные версии SARIF между различными версиями CodeQL.

              `sarifv2.1.0`: SARIF версии 2.1.0.

              `text`: список точек маркера диагностических сообщений.

#### `-o, --output=<output>`

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

#### `--sarif-exit-code=<sarifExitCode>`

              \[Только форматы SARIF] Код выхода из неработоемого процесса.

#### `--sarif-exit-code-description=<sarifExitCodeDescription>`

              \[Только форматы SARIF] Причина завершения сбоя процесса.

#### `--sarif-category=<category>`

              \[Только форматы SARIF] \[Рекомендуется] Укажите категорию для этого анализа, включаемую в выходные данные SARIF. Категорию можно использовать для различения нескольких анализов, выполняемых в одном и том же фиксации и репозитории, но на разных языках или в разных частях кода.

Если вы анализируете одну и ту же версию базы кода различными способами (например, для разных языков) и отправляете результаты в GitHub для презентации в сканировании кода, это значение должно отличаться между каждым из анализов, что указывает сканирование кода, что дополнение_ к анализу_, а не _заменять_ друг друга. (Значения должны быть согласованы между выполнением одного и того же анализа для _разных_ версий базы кода.)

Это значение будет отображаться (с косой косой чертой, добавленной, если она еще не присутствует) в качестве `<run>.automationDetails.id` свойства.

#### `--diagnostic-dir=<diagnosticDirs>`

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

### Распространенные параметры

#### `-h, --help`

Отображение этого текста справки.

#### `-J=<opt>`

              \[Дополнительно] Укажите параметр JVM, выполняя команду.

(Убедитесь, что параметры, содержащие пробелы, не будут обрабатываться правильно.)

#### `-v, --verbose`

Постепенно увеличьте число отображаемых сообщений о ходе выполнения.

#### `-q, --quiet`

Постепенно уменьшайте количество отображаемых сообщений о ходе выполнения.

#### `--verbosity=<level>`

              \[Дополнительно] Явным образом задайте уровень детализации на одну из ошибок, предупреждений, хода выполнения, хода выполнения+, хода выполнения++, хода выполнения+++. Переопределяет `-v` и `-q`.

#### `--logdir=<dir>`

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

(Чтобы записать файл журнала с именем, над которым у вас есть полный контроль, вместо этого предоставьте `--log-to-stderr` и перенаправите stderr по мере необходимости.)

#### `--common-caches=<dir>`

              \[Дополнительно] Управляет расположением кэшированных данных на диске, которые будут сохраняться между несколькими запусками интерфейса командной строки, такими как скачанные пакеты QL и скомпилированные планы запросов. Если этот параметр не задан явным образом, по умолчанию используется каталог с именем `.codeql` в домашнем каталоге пользователя; он будет создан, если он еще не существует.

Доступно с момента `v2.15.2`.