데이터베이스 해석 결과

이 콘텐츠는 CodeQL CLI의 최신 릴리스에 대해 설명합니다. 이 릴리스에 대한 자세한 내용은 를 참조하세요 https://github.com/github/codeql-cli-binaries/releases.

이전 릴리스에서 이 명령에 사용할 수 있는 옵션에 대한 세부 정보를 보려면 터미널에서 옵션을 사용하여 명령을 --help 실행합니다.

개요

Shell

codeql database interpret-results --format=<format> --output=<output> [--threads=<num>] <options>... -- <database> <file|dir|suite>...

Description

[배관] 계산된 쿼리 결과를 SARIF 또는 CSV와 같은 의미 있는 형식으로 해석합니다.

결과는 codeql 데이터베이스 run-queries를 사용하여 CodeQL 데이터베이스 디렉터리에 계산되고 저장되어야 합니다. (일반적으로 codeql 데이터베이스 분석을 사용하여 이러한 단계를 함께 수행하려고 합니다.)

기본 옵션

`<database>`

[필수] 쿼리된 CodeQL 데이터베이스의 경로입니다.

`<filesuite>...`

여기서 실행된 쿼리의 사양을 반복합니다.

생략하면 CLI는 codeql 데이터베이스 run-queries와 동일한 논리를 사용하여 적절한 쿼리 집합을 결정합니다.

(이후 버전에서는 이를 생략하고 대신 데이터베이스에 있는 모든 결과를 해석할 수 있어야 합니다. 그 영광스러운 미래는 아직 없습니다. 죄송합니다.)

`--format=<format>`

[필수] 결과를 작성할 형식입니다. 다음 중 하나:

csv: 규칙 및 경고 메타데이터가 모두 있는 열을 포함하여 형식이 지정된 쉼표로 구분된 값입니다.

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

sarifv2.1.0: SARIF v2.1.0.

graphtext: 그래프를 나타내는 텍스트 형식입니다. 그래프를 사용하는 쿼리와 @kind 만 호환됩니다.

dgml: 그래프를 설명하기 위한 XML 기반 형식인 Directed Graph 태그 언어입니다. 그래프를 사용하는 쿼리와 @kind 만 호환됩니다.

dot: 그래프를 설명하기 위한 텍스트 기반 형식인 Graphviz DOT 언어입니다. 그래프를 사용하는 쿼리와 @kind 만 호환됩니다.

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

[필수] 결과를 쓸 출력 경로입니다. 그래프 형식의 경우 디렉터리여야 하며 결과(또는 이 명령이 둘 이상의 쿼리 해석을 지원하는 경우 결과)는 해당 디렉터리 내에 기록됩니다.

`--max-paths=<maxPaths>`

경로가 있는 각 경고에 대해 생성할 최대 경로 수입니다. (기본값: 4)

`--[no-]sarif-add-file-contents`

[SARIF 형식만 해당] 하나 이상의 결과에서 참조되는 모든 파일에 대한 전체 파일 내용을 포함합니다.

`--[no-]sarif-add-snippets`

[SARIF 형식만] 결과에 언급된 각 위치에 대한 코드 조각을 보고된 위치 앞과 뒤의 두 줄 컨텍스트와 함께 포함합니다.

`--[no-]sarif-add-query-help`

[SARIF 형식만] 결과에 Markdown 쿼리 도움말을 포함합니다. /path/to/query.md 파일에서 /path/to/query.ql에 대한 쿼리 도움말을 로드합니다. 이 옵션은 codeql bqrs interpret에 전달될 때 아무런 영향을 주지 않습니다.

`--[no-]sarif-group-rules-by-pack`

[SARIF 형식만] 속성의 해당 QL 팩 아래에 각 쿼리에 대한 규칙 개체를 <run>.tool.extensions 배치합니다. 이 옵션은 codeql bqrs interpret에 전달될 때 아무런 영향을 주지 않습니다.

`--[no-]sarif-multicause-markdown`

[SARIF 형식만 해당] 여러 원인이 있는 경고의 경우 일반 문자열 외에도 출력에 Markdown 형식의 항목별 목록으로 포함합니다.

`--no-group-results`

[SARIF 형식만] 고유한 위치당 하나의 결과가 아닌 메시지당 하나의 결과를 생성합니다.

`--csv-location-format=<csvLocationFormat>`

CSV 출력에서 위치를 생성할 형식입니다. uri, 줄 열, 오프셋 길이 중 하나입니다. (기본값: 줄 열)

`--dot-location-url-format=<dotLocationUrlFormat>`

DOT 출력에서 파일 위치 URL을 생성할 형식을 정의하는 형식 문자열입니다. 다음 자리 표시자를 사용할 수 있습니다 {path} {start:line} {start:column} {end:line} {end:column}, {offset}, {length}

`--sarif-category=<category>`

[SARIF 형식만] SARIF 출력에 포함할 이 분석의 범주를 지정합니다. 범주를 사용하여 동일한 커밋 및 리포지토리에서 수행되는 여러 분석을 서로 다른 언어 또는 코드의 다른 부분에서 구분할 수 있습니다.

여러 가지 방법으로 동일한 버전의 코드 베이스를 분석하고(예: 다른 언어의 경우) 코드 검사에서 프레젠테이션을 위해 결과를 GitHub에 업로드하는 경우 이 값은 각 분석 간에 달라야 합니다. 이 값은 코드 검사에서 분석이 서로를 대체하지 않고 보완한다는 것을 알려 줍니다. (값은 코드 베이스의 다른 버전에 대해 동일한 분석의 실행 간에 일치해야 합니다.)

이 값은 SARIF v1의 <run>.automationId 속성, SARIF v2의 <run>.automationLogicalId 속성, SARIF v2.1.0의 <run>.automationDetails.id 속성으로 표시됩니다(아직 없는 경우 후행 슬래시가 추가됨).

`-j, --threads=<num>`

컴퓨팅 경로에 사용되는 스레드 수입니다.

기본값은 1입니다. 0을 전달하여 컴퓨터의 코어당 하나의 스레드를 사용하거나 -N 을 전달하여 N 코어를 사용하지 않은 상태로 둘 수 있습니다(하나 이상의 스레드를 계속 사용).

`--[no-]print-diagnostics-summary`

분석된 진단 요약을 표준 출력에 인쇄합니다.

`--[no-]print-metrics-summary`

분석된 메트릭의 요약을 표준 출력에 인쇄합니다.

`--[no-]print-baseline-loc`

표준 출력으로 계산된 코드의 기준선을 인쇄합니다.

CodeQL 패키지 관리자 구성 옵션

`--registries-auth-stdin`

쉼표로 구분된 쌍 목록을 \<registry_url>=\ 전달하여 GitHub Enterprise Server Container 레지스트리에 인증합니다.

예를 들어 를 전달할 수 있습니다. https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2 두 개의 GitHub Enterprise Server 인스턴스에 인증합니다.

이렇게 하면 CODEQL_REGISTRIES_AUTH 및 GITHUB_TOKEN 환경 변수가 재정의됩니다. github.com Container Registry에만 인증해야 하는 경우 더 --github-auth-stdin 간단한 옵션을 사용하여 인증할 수 있습니다.

`--github-auth-stdin`

표준 입력을 통해 github.com GitHub 앱 토큰 또는 개인용 액세스 토큰을 전달하여 github.com Container 레지스트리에 인증합니다.

GitHub Enterprise Server Container Registries에 인증하려면 CODEQL_REGISTRIES_AUTH 환경 변수를 전달 --registries-auth-stdin 하거나 사용합니다.

그러면 GITHUB_TOKEN 환경 변수가 재정의됩니다.

QL 팩을 찾는 옵션(쿼리 도구 모음을 해석하는 데 필요할 수 있음)

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

QL 팩을 찾을 수 있는 디렉터리 목록입니다. 각 디렉터리가 QL 팩(또는 루트에 파일이 포함된 .codeqlmanifest.json 팩 번들) 또는 하나 이상의 디렉터리의 직접 부모일 수 있습니다.

경로에 둘 이상의 디렉터리가 포함된 경우 해당 순서는 둘 사이의 우선 순위를 정의합니다. 해결해야 하는 팩 이름이 디렉터리 트리 중 하나 이상에서 일치하는 경우 첫 번째 우선 순위가 지정됩니다.

오픈 소스 CodeQL 리포지토리의 체크 아웃에서 이를 가리키는 것은 해당 위치에 있는 언어 중 하나를 쿼리할 때 작동해야 합니다.

압축이 풀린 CodeQL 도구 체인의 형제로 CodeQL 리포지토리를 체크 아웃한 경우 이 옵션을 제공할 필요가 없습니다. 이러한 형제 디렉터리에서는 달리 찾을 수 없는 QL 팩을 항상 검색합니다. (이 기본값이 작동하지 않는 경우 사용자별 구성 파일에서 한 번만 설정하는 --search-path 것이 좋습니다.)

(참고: Windows에서 경로 구분 기호는 )입니다 ;.

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

이 디렉터리 목록이 제공되면 에 있는 --search-path디렉터리 앞에 있는 팩을 검색합니다. 이 사이의 순서는 중요하지 않습니다. 팩 이름이 이 목록을 통해 서로 다른 두 위치에 있는 경우 오류입니다.

이는 기본 경로에도 표시되는 새 버전의 팩을 일시적으로 개발하는 경우에 유용합니다. 반면에 구성 파일에서 이 옵션을 재정의 하지 않는 것이 좋습니다 . 일부 내부 작업은 구성된 값을 재정의하여 즉시 이 옵션을 추가합니다.