데이터베이스 해석 결과

데이터 재사용 코드ql-cli.man-pages-version-note %}

개요

Shell

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

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

Description

          \[내부 구현] 계산된 쿼리 결과를 SARIF 또는 CSV와 같이 유의미한 형식으로 해석합니다.

결과는 계산한 뒤 codeql database run-queries를 사용해 CodeQL 데이터베이스 디렉터리에 저장되었을 것입니다. (일반적으로 codeql database analyze를 이용해 이 단계들을 함께 수행하면 좋습니다).

Options

기본 옵션

`<database>`

          \[필수] 쿼리된 CodeQL 데이터베이스 경로.

`<file|dir|suite>...`

여기에서 실행된 쿼리의 지정 내용을 다시 반복합니다.

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

(향후 버전에서는 이것을 생략하고 데이터베이스에 관찰되는 모든 결과를 해석할 수 있어야 합니다. 영광스러운 미래는 아직 오지 않았습니다. 유감스럽습니다.)

`--format=<format>`

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

          `csv`: 규칙 및 경고 메타데이터를 모두 포함한 열로 구성되어 형식이 지정된(콤마로 구분된) 값 출력.

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

          `sarifv2.1.0`: SARIF v2.1.0입니다.

          `graphtext`: 그래프를 나타내는 텍스트 형식. 
          @kind 그래프가 있는 쿼리와만 호환됩니다.

          `dgml`: 그래프를 설명하기 위한 XML 기반 형식, Directed Graph Markup Language. 
          @kind 그래프가 있는 쿼리와만 호환됩니다.

          `dot`: 그래프를 설명하기 위한 텍스트 기반 형식, Graphviz DOT 언어.

          @kind 그래프가 있는 쿼리와만 호환됩니다.

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

          \[필수] 결과를 기록할 출력 경로. 그래프 형식의 경우 이것은 디렉터리가 되어야 하며, 결과(또는 이 명령이 2개 이상의 쿼리 해석을 지원하는 경우 각각의 결과)가 해당 디렉터리 내에 저장됩니다.

`--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/\<lang\&rt;-queries\` 형식이 아닌 쿼리 팩에 있는 사용자 지정 쿼리에 대해서만 도움말을 포함시키는 것이 기본 동작입니다. 이 옵션은 [codeql bqrs interpret](/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret)으로 전달될 때는 영향을 미치지 않습니다.

`--sarif-include-query-help=<mode>`

          \[SARIF 형식만 해당] SARIF 출력에 쿼리 도움말을 포함할지 여부를 지정합니다. 다음 중 하나입니다.

          `always`: 모든 쿼리에 대한 쿼리 도움말을 포함합니다.

          `custom_queries_only`
          _(기본값)_: 사용자 지정 쿼리에 대해서만 쿼리 도움말을 포함하며, 가령 \`codeql/\<lang\&rt;-queries\` 형식이 아닌 쿼리 팩에 있는 쿼리 도움말을 예로 들 수 있습니다.

          `never`: 어떠한 쿼리에 대한 쿼리 도움말도 포함하지 않습니다.

이 옵션은 codeql bqrs interpret으로 전달될 때는 영향을 미치지 않습니다.

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

`--no-sarif-include-alert-provenance`

          \[고급] \[SARIF 형식만 해당] SARIF 출력에는 경고 출처 정보가 포함되지 않습니다.

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

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

          \[SARIF 형식만 해당] 각 쿼리의 규칙 객체를 해당 QL 팩 아래에 배치하여 `<run>.tool.extensions` 속성에 포함합니다. 이 옵션은 [codeql bqrs interpret](/code-security/reference/code-scanning/codeql/codeql-cli-manual/bqrs-interpret)으로 전달될 때는 영향을 미치지 않습니다.

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

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

`--no-sarif-minify`

          \[SARIF 형식만 해당] 가독성 있게 포맷된 SARIF 출력을 생성합니다. SARIF 출력은 파일 크기를 줄이기 위해 축소된 형태로 생성되는 것이 기본값입니다.

`--sarif-run-property=<String=String>`

          \[SARIF 형식만 해당] 생성된 SARIF 'run' 속성 모음에 추가할 키 값 쌍. 반복할 수 있습니다.

`--no-group-results`

          \[SARIF 형식만 해당] 고유한 위치마다 하나의 결과를 생성하는 것이 아니라 메시지마다 하나의 결과를 생성합니다.

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

CSV 출력에 위치 정보를 생성하기 위한 형식. uri, line-column, offset-length 중 하나의 값입니다. (기본값: 행-열)

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

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

`--[no-]sublanguage-file-coverage`

          \[GitHub.com 및 GitHub Enterprise Server v3.12.0 이상만 해당] 하위 언어 파일 적용 범위에 대한 정보를 사용합니다. 이것은 C와 C++, Java, Kotlin, JavaScript, TypeScript 등 CodeQL 추출기를 공유하는 언어에 대해 별도의 파일 적용 범위 정보를 계산, 표시 및 내보내기 합니다.

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

`--sarif-category=<category>`

          \[SARIF 형식만 해당] \[권장] 이 분석에서 SARIF 출력에 포함시킬 범주를 지정합니다. 범주를 이용해 동일한 도구와 커밋을 대상으로 실행되지만 서로 다른 언어나 코드 부분에 대해 실행되는 다수의 분석을 구별할 수 있습니다.

동일한 코드베이스 버전을 여러 가지 방식(예: 서로 다른 언어)에 대해 분석하고 그 결과를 코드 스캐닝에 표시하기 위해 GitHub로 업로드하는 경우, 이 값은 각 분석마다 달라야 하며, 이렇게 하면 코드 스캐닝은 서로 다른 분석들이 서로를 _대체_하는 것이 아니라 서로를 _보완_함을 인식하게 됩니다. (이 값들은 코드베이스의 서로 다른 버전에 대해 동일한 분석을 여러 번 실행하도록 일관성이 유지되어야 합니다.)

이 값은 <run>.automationDetails.id 속성으로 표시되며, 아직 슬래시가 없는 경우 뒤에 슬래시가 추가됩니다.

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

경로를 계산하는 데에 사용되는 스레드 수입니다.

기본값은 1입니다. 머신의 코어당 한 개의 스레드를 사용하기 위해 0을 전달하거나, -_N_을 전달하여 _N_개의 코어를 미사용 상태로 둘 수 있습니다(단, 여전히 1개 이상의 스레드를 사용합니다).

`--no-database-extension-packs`

          \[고급] 데이터베이스 생성 시 코드 스캐닝 구성 파일에 지정되어 있거나 분석 대상 코드베이스의 ‘extensions’ 디렉터리에 저장된 확장 팩을 데이터베이스에서 제외합니다.

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

분석된 진단 결과 요약을 표준 출력으로 출력합니다.

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

분석된 메트릭의 요약을 표준 출력으로 출력합니다.

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

기준으로 집계된 코드 줄 수를 표준 출력으로 출력합니다.

CodeQL 패키지 관리자 구성 옵션

`--registries-auth-stdin`

GitHub Enterprise Server 컨테이너 레지스트리에 인증하기 위해 <registry_url>=<token> 쌍을 쉼표로 구분한 목록을 전달합니다.

예를 들어, 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 Apps 토큰 또는 개인용 액세스 토큰을 github.com에 전달하여 표준 입력을 통해 github.com 컨테이너 레지스트리에 인증합니다.

GitHub Enterprise Server 컨테이너 레지스트리에 인증하기 위해 --registries-auth-stdin을 전달하거나 CODEQL_REGISTRIES_AUTH 환경 변수를 사용합니다.

이는 GITHUB_TOKEN 환경 변수를 재정의합니다.

결과를 해석할 때 사용할 확장을 지정하기 위한 옵션

          `--model-packs=<`
          <name@range>>...

선택적인 버전 범위가 있는 CodeQL 팩 이름 목록을 모델 팩으로 이용하여 평가할 쿼리를 사용자 지정합니다.

쿼리 도구 모음 분석에 필요할 수 있는 QL 팩을 검색하는 옵션.

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

QL 팩이 위치할 수 있는 디렉터리 목록입니다. 각 디렉터리는 QL 팩(또는 루트에 .codeqlmanifest.json 파일이 포함된 팩 번들)일 수도 있고, 하나 이상의 이러한 디렉터리의 직계 부모일 수 있습니다.

하나 이상의 디렉터리가 경로에 포함된 경우 해당 순서가 우선순위를 정의합니다. 확인해야 하는 팩 이름이 여러 디렉터리 트리에서 일치하는 경우 먼저 지정된 트리가 우선합니다.

이를 오픈 소스 CodeQL 리포지토리의 체크 아웃 위치로 지정하면, 해당 리포지토리에 있는 언어 중 하나를 쿼리할 때 정상적으로 동작합니다.

CodeQL 리포지토리를 압축을 푼 CodeQL 툴체인의 형제로 체크 아웃한 경우에는 이 옵션을 지정할 필요가 없습니다. 다른 방법으로는 찾을 수 없는 QL 팩으로 이러한 형제 디렉터리가 항상 검색됩니다. (이러한 기본값이 작동하지 않는 경우, 사용자별 구성 파일에 --search-path를 한 번만 설정할 것을 강력히 권고합니다.)

(참고: Windows에서는 경로 구분 기호로 ;을(를) 사용합니다.)

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

해당 디렉터리 목록이 지정된 경우 팩이 --search-path에 있는 디렉터리보다 먼저 검색됩니다. 그 사이의 순서는 중요하지 않습니다. 서로 다른 두 위치에서 팩 이름을 이 목록을 통해 찾을 경우에는 오류가 발생합니다.

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

(참고: Windows에서는 경로 구분 기호로 ;을(를) 사용합니다.)

          \[고급] 명령을 실행하는 JVM에 옵션을 제공합니다.

(옵션에 공백이 포함되면 제대로 처리되지 않을 수 있는 점에 유의해야 합니다.)

          \[고급] 세부 정보 표시 수준을 명시적으로 오류, 경고, 진행률, 진행률+, 진행률++, 진행률+++ 중 하나로 설정합니다. 
          `-v` 및 `-q`를 재정의합니다.

`--logdir=<dir>`

          \[고급] 지정한 디렉터리에 상세 로그를 하나 이상의 파일로 작성하며, 생성된 이름에는 타임스탬프와 실행 중인 하위 명령 이름을 포함합니다.

(로그 파일 이름을 직접 작성하기 위해, --log-to-stderr를 지정하고 원하는 위치로 stderr를 리디렉션하는 방법도 있습니다.)

`--common-caches=<dir>`

          \[고급] 다운로드한 QL 팩 및 컴파일된 쿼리 계획 등 CLI를 여러 번 실행해도 지속되는 디스크의 캐시된 데이터의 위치를 제어합니다. 명시적으로 설정하지 않으면, 기본적으로 사용자의 홈 디렉터리에 이름이 지정된 `.codeql` 디렉터리로 설정됩니다. 디렉터리가 아직 없는 경우에는 만들어집니다.

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

누가 이 기능을 사용할 수 있나요?

이 기사에서