데이터베이스 해석 결과

참고 항목

이 콘텐츠는 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>...

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와 동일한 논리를 사용하여 적절한 쿼리 집합을 결정합니다.

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

`-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/\<lang\&queries\`형식이 아닌 쿼리 팩에 대해서만 도움말이 포함됩니다. 이 옵션은 [codeql bqrs 해석](/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret)에 전달될 때 적용되지 않습니다.

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

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

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

          `custom_queries_only`              _(기본값)_: 사용자 지정 쿼리에 대해서만 쿼리 도움말을 포함합니다. 즉, \`codeql/\<lang\&rt;-queries\` 형식이 아닌 쿼리 팩에 쿼리 도움말을 포함합니다.

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

이 옵션은 codeql bqrs 해석에 전달될 때 적용되지 않습니다.

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

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

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

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

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

          \[SARIF 형식만 해당] `<run>.tool.extensions` 각 쿼리에 대한 규칙 개체는 해당 QL 팩 아래의 속성에 배치합니다. 이 옵션은 [codeql bqrs 해석](/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret)에 전달될 때 적용되지 않습니다.

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

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

`--no-sarif-minify`

          \[SARIF 형식만] 자동 서식 지정 SARIF 출력을 생성합니다. 기본적으로 SARIF 출력은 파일 크기를 줄이기 위해 축소된 형태로 생성됩니다.

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

          \[SARIF 형식 전용] 생성된 SARIF '실행' 속성 모음에 추가할 키 값 쌍입니다. 반복할 수 있습니다.

`--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 개의 코어를 비활성화할 수 있습니다. 단, 최소 한 개의 스레드는 항상 사용 가능합니다.

`--no-database-extension-packs`

          \[고급] 데이터베이스를 생성할 때, 코드 검사 구성 파일이나 분석된 코드베이스의 ‘확장’ 디렉터리에 저장된 확장 파일은 데이터베이스에서 생략됩니다.

`--[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 컨테이너 레지스트리에 인증만 필요한 경우 --github-auth-stdin 옵션을 사용하여 간편하게 인증할 수 있습니다.

`--github-auth-stdin`

GitHub 앱 토큰 또는 개인 액세스 토큰을 사용하여 표준 입력으로 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부터 사용할 수 있습니다.

데이터베이스 해석 결과

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

이 문서의 내용