이 콘텐츠는 CodeQL CLI의 최신 릴리스에 대해 설명합니다. 이 요소에 대한 자세한 내용은 https://github.com/github/codeql-cli-binaries/releases을(를) 참조하세요.
이전 릴리스에서 이 명령에 사용할 수 있는 옵션의 세부 정보를 보려면 터미널에서 옵션을 사용하여 --help 명령을 실행합니다.
개요
codeql bqrs interpret --format=<format> --output=<output> -t=<String=String> [--threads=<num>] [--source-archive=<sourceArchive>] [--source-location-prefix=<sourceLocationPrefix>] <options>... -- <bqrs-file>
codeql bqrs interpret --format=<format> --output=<output> -t=<String=String> [--threads=<num>] [--source-archive=<sourceArchive>] [--source-location-prefix=<sourceLocationPrefix>] <options>... -- <bqrs-file>
설명
[연결] 단일 BQRS에서 데이터를 해석합니다.
제공된 메타데이터에 따라 단일 BQRS 파일을 해석하고 지정된 형식으로 출력을 생성하는 명령입니다.
옵션
기본 옵션
<bqrs-file>
[필수] 해석할 BQRS 파일입니다.
--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 Markup Language입니다. @kind 그래프가 있는 쿼리만 호환됩니다.
dot: 그래프를 설명하기 위한 텍스트 기반 형식인 Graphviz DOT 언어입니다.
@kind 그래프가 있는 쿼리만 호환됩니다.
-o, --output=<output>
[필수] 결과를 기록할 출력 경로입니다. 그래프 형식의 경우 디렉터리여야 하며 결과(또는 이 명령이 둘 이상의 쿼리 해석을 지원하는 경우의 결과)는 해당 디렉터리 내에 기록됩니다.
-t=<String=String>
[필수] 쿼리 메타데이터 키 값 쌍입니다. 메타데이터의 각 부분을 반복합니다. 적어도 키 '종류' 및 'ID'를 지정해야 합니다. 키는 접두사로 @을(를) 사용할 필요가 없습니다.
--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 해석에 전달될 때 적용되지 않습니다.
--sarif-include-query-help=<mode>
[SARIF 형식만] SARIF 출력에 쿼리 도움말을 포함할지 여부를 지정합니다. 다음 중 하나입니다.
always: 모든 쿼리에 대한 쿼리 도움말을 포함합니다.
custom_queries_only (기본값): 사용자 지정 쿼리에 대해서만 쿼리 도움말을 포함합니다. 즉, `codeql/<lang&rt;-queries` 형식이 아닌 쿼리 팩에 쿼리 도움말을 포함합니다.
never: 쿼리에 대한 쿼리 도움말을 포함하지 않습니다.
이 옵션은 codeql bqrs 해석에 전달될 때 적용되지 않습니다.
v2.15.2부터 사용할 수 있습니다.
--[no-]sarif-group-rules-by-pack
[SARIF 형식만 해당] <run>.tool.extensions 속성의 해당 QL 팩 아래에 각 쿼리에 대한 규칙 개체를 배치합니다. 이 옵션은 codeql bqrs 해석에 전달될 때 적용되지 않습니다.
--[no-]sarif-multicause-markdown
[SARIF 형식만 해당] 여러 원인이 있는 경고의 경우 일반 문자열 외에도 출력에 Markdown 형식의 항목별 목록으로 포함합니다.
--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_개의 코어를 사용하지 않은 상태로 둘 수 있습니다(하나 이상의 스레드를 계속 사용하는 경우 제외).
--sarif-run-property=<String=String>
[SARIF 전용] 생성된 SARIF '실행' 속성 모음에 추가할 키 값 쌍입니다. 반복할 수 있습니다.
--column-kind=<columnKind>
[SARIF 전용] 위치 열을 해석하는 데 사용되는 열 종류입니다. utf8, utf16, utf32, 바이트 중 하나입니다.
--[no-]unicode-new-lines
[SARIF 전용] 위치 줄 번호를 해석할 때 유니코드 줄 바꿈 문자인 LS(줄 구분 기호, U+2028) 및 PS(단락 구분 기호, U+2029)가 새 줄로 간주되는지 여부입니다.
원본 보관 옵션 - 동시에 제공되거나 제공되지 않아야 합니다.
-s, --source-archive=<sourceArchive>
원본 보관 파일이 포함된 디렉터리 또는 zip 파일입니다.
-p, --source-location-prefix=<sourceLocationPrefix>
소스 코드가 저장된 원래 파일 시스템의 파일 경로입니다.
일반 옵션
-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부터 사용할 수 있습니다.