diagnostic export

개요

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

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

설명

[실험적] 실패한 분석에 대한 진단 정보를 내보냅니다.

v2.12.6부터 사용할 수 있습니다.

옵션

기본 옵션

--format=<format>

[필수] 결과를 기록할 형식입니다. 다음 중 하나입니다.

raw: JSON 개체로, 해석되지 않는 원시 진단 메시지 목록입니다.

sarif-latest: 정적 분석 결과를 설명하기 위한 JSON 기반 형식인 정적 분석 결과 교환 형식(SARIF)입니다. 이 형식 옵션은 지원되는 최신 버전(v2.1.0)을 사용합니다. 이 옵션은 서로 다른 CodeQL 버전 간에 서로 다른 버전의 SARIF를 생성하므로 자동화에 사용하기에 적합하지 않습니다.

sarifv2.1.0: SARIF v2.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 팩 및 컴파일된 쿼리 계획과 같이 여러 CLI 실행 간에 유지되는 디스크의 캐시된 데이터의 위치를 제어합니다. 명시적으로 설정하지 않은 경우 이 기본값은 사용자의 홈 디렉터리에 이름이 지정된 .codeql 디렉터리로 설정되며, 아직 없는 경우 만들어집니다.

v2.15.2부터 사용할 수 있습니다.