bqrs interpret

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

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

개요

Shell

codeql bqrs interpret --format=<format> --output=<output> -t=<String=String> [--threads=<num>] [--source-archive=<sourceArchive>] [--source-location-prefix=<sourceLocationPrefix>] <options>... -- <bqrs-file>

Description

[배관] 단일 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 태그 언어입니다. 그래프가 있는 쿼리와 @kind 만 호환됩니다.

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

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

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

`-t=<String=String>`

[필수] 쿼리 메타데이터 키 값 쌍입니다. 메타데이터의 각 부분에 대해 반복합니다. 적어도 'kind' 및 '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 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 속성으로 표시됩니다(아직 없는 경우 후행 슬래시가 추가됨).

bqrs interpret

이 문서의 내용

개요

Description

기본 옵션

`<bqrs-file>`

`--format=<format>`

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

`-t=<String=String>`

`--max-paths=<maxPaths>`

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

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

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

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

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

`--no-group-results`

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

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

`--sarif-category=<category>`

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

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

`--column-kind=<columnKind>`

`--[no-]unicode-new-lines`

원본 보관 옵션 - 함께 제공되거나 전혀 제공되지 않아야 합니다.

`-s, --source-archive=<sourceArchive>`

`-p, --source-location-prefix=<sourceLocationPrefix>`

일반 옵션

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`