데이터베이스 인덱스 파일

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

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

개요

Shell

codeql database index-files --language=<lang> [--threads=<num>] [--ram=<MB>] [--extractor-option=<extractor-option-name=value>] <options>... -- <database>

Description

[배관] 지정된 CodeQL 추출기를 사용하여 독립 실행형 파일을 인덱싱합니다.

이 명령은 지정된 작업 디렉터리에서 파일 집합을 선택하고 지정된 추출기를 적용합니다. 기본적으로 모든 파일이 선택됩니다. 일반적인 호출은 포함된 파일 집합을 제한하는 옵션을 지정합니다.

--include, --exclude및 --prune 옵션은 모두 다음 와일드카드 문자를 사용할 수 있는 glob 패턴을 사용합니다.

단일 "?"는 앞으로/뒤로 슬래시 이외의 문자와 일치합니다.
단일 "*"는 앞으로/뒤로 슬래시 이외의 임의의 문자 수와 일치합니다.
패턴 "**"은 0개 이상의 전체 디렉터리 구성 요소와 일치합니다.

기본 옵션

`<database>`

[필수] 생성 중인 CodeQL 데이터베이스의 경로입니다. codeql 데이터베이스 init를 사용하여 추출할 준비가 되어 있어야 합니다.

`-l, --language=<lang>`

[필수] 일치하는 파일을 인덱싱하는 데 사용해야 하는 추출기입니다.

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

추출기에서 이 많은 스레드를 사용하도록 요청합니다. 이 옵션은 제안으로 추출기로 전달됩니다. CODEQL_THREADS 환경 변수가 설정된 경우 환경 변수 값이 이 옵션보다 우선합니다.

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

`-M, --ram=<MB>`

추출기에서 이 많은 메모리를 사용하도록 요청합니다. 이 옵션은 제안으로 추출기로 전달됩니다. CODEQL_RAM 환경 변수가 설정된 경우 환경 변수 값이 이 옵션보다 우선합니다.

`--working-dir=<dir>`

[고급] 지정된 명령을 실행해야 하는 디렉터리입니다. 이 인수를 제공하지 않으면 codeql 데이터베이스 create에 전달된 값--source-root(있는 경우)에서 명령이 실행됩니다. --source-root 인수가 제공되지 않으면 명령이 현재 작업 디렉터리에서 실행됩니다.

추출기 동작을 제어하는 옵션

`-O, --extractor-option=<extractor-option-name=value>`

CodeQL 추출기에 대한 옵션을 설정합니다. extractor-option-name 는 폼 추출기_이름.group1.group2.option_이름 또는 group1.group2.option_이름이어야 합니다. 추출기 이름으로 시작하는 경우 extractor_option_name 표시된 추출기는 group1.group2.option_옵션 이름을 선언해야 합니다. 그렇지 않으면 group1.group2.option_옵션 이름을 선언하는 모든 추출기에서 옵션이 설정됩니다. value 는 줄줄을 포함하지 않는 모든 문자열일 수 있습니다.

이 명령줄 옵션을 반복적으로 사용하여 여러 추출기 옵션을 설정할 수 있습니다. 동일한 추출기 옵션에 여러 값을 제공하는 경우 동작은 추출기 옵션이 예상하는 형식에 따라 달라집니다. 문자열 옵션은 제공된 마지막 값을 사용합니다. 배열 옵션은 제공된 모든 값을 순서대로 사용합니다. 이 명령줄 옵션을 사용하여 지정된 추출기 옵션은 를 통해 --extractor-options-file제공된 추출기 옵션 후에 처리됩니다.

codeql database init 또는 codeql database begin-tracing에 전달되는 경우 옵션은 간접 추적 환경에만 적용됩니다. 워크플로에서 codeql 데이터베이스 trace-command 를 호출하는 경우 원하는 경우 옵션도 전달해야 합니다.

각 추출기에서 선언한 옵션을 나열하는 방법을 포함하여 CodeQL 추출기 옵션에 대한 자세한 내용은 를 참조하세요 https://codeql.github.com/docs/codeql-cli/extractor-options .

`--extractor-options-file=<extractor-options-bundle-file>`

추출기 옵션 번들 파일을 지정합니다. 추출기 옵션 번들 파일은 추출기 옵션을 설정하는 JSON 파일(확장명 .json) 또는 YAML 파일(확장명 .yaml 또는 .yml)입니다. 파일에는 최상위 맵 키 'extractor'가 있어야 하며, 그 아래에는 추출기 이름이 두 번째 수준 맵 키로 있어야 합니다. 지도의 추가 수준은 중첩된 추출기 그룹을 나타내고 문자열 및 배열 옵션은 문자열 및 배열 값이 있는 맵 항목입니다.

추출기 옵션 번들 파일은 지정된 순서대로 읽습니다. 다른 추출기 옵션 번들 파일에서 동일한 추출기 옵션을 지정하는 경우 동작은 추출기 옵션이 예상하는 형식에 따라 달라집니다. 문자열 옵션은 제공된 마지막 값을 사용합니다. 배열 옵션은 제공된 모든 값을 순서대로 사용합니다. 이 명령줄 옵션을 사용하여 지정된 추출기 옵션은 를 통해 --extractor-option제공된 추출기 옵션 전에 처리됩니다.

codeql database init 또는 codeql database begin-tracing에 전달되는 경우 옵션은 간접 추적 환경에만 적용됩니다. 워크플로에서 codeql 데이터베이스 trace-command 를 호출하는 경우 원하는 경우 옵션도 전달해야 합니다.

각 추출기에서 선언한 옵션을 나열하는 방법을 포함하여 CodeQL 추출기 옵션에 대한 자세한 내용은 를 참조하세요 https://codeql.github.com/docs/codeql-cli/extractor-options .

인덱싱된 파일 집합을 제한하는 옵션

`--include-extension=<.ext>`

지정된 확장명이 있는 모든 파일을 검색 디렉터리 트리에 포함합니다. 일반적으로 확장 앞에 점을 포함해야 합니다. 예를 들어 전달 --include-extension .xml 에는 ".xml" 확장이 있는 모든 파일이 포함됩니다. 이 옵션은 부정 --include 된 옵션과 호환되지 않습니다.

`--include=<glob>`

검색 디렉터리에서 각 파일 및 디렉터리의 상대 경로를 사용하여 지정된 glob과 일치하는 모든 파일 및 디렉터리를 검색 디렉터리 트리에 포함합니다. glob이 문자로 ! 시작하는 경우 일치하는 파일 및 디렉터리 대신 제외됩니다.

--include 옵션은 순서대로 처리되며, 이후 옵션은 이전 옵션을 재정의합니다. 예를 들어 --include ** --include !sub/*.ts --include sub/main.* 에는 (에 포함sub/main.*되기 때문에 ), exclude sub/index.ts (에 의해 !sub/*.ts제외되기 때문에) 및 include sub/test.js (이후에 제외되지 않고 에 포함 ** 되기 때문)가 포함 sub/main.ts 됩니다.

`--also-match=<glob>`

검색 디렉터리에서 각 파일 및 디렉터리의 상대 경로를 사용하여 지정된 glob과 일치하도록 모든 결과가 필요합니다. 이 옵션은 구조와 해석 --include 이 동일하지만 와 함께 --include적용되는 별도의 globs 시퀀스를 지정합니다.

`--exclude=<glob>`

검색 디렉터리에서 각 파일 및 디렉터리의 상대 경로를 사용하여 지정된 glob과 일치하는 모든 파일 및 디렉터리를 제외합니다. 이 옵션은 모든 포함 옵션을 재정의합니다. 이 옵션은 부정 --include 된 옵션과 호환되지 않습니다.

`--prune=<glob>`

검색 디렉터리에서 각 파일 및 디렉터리의 상대 경로를 사용하여 지정된 glob과 일치하는 모든 파일 및 디렉터리를 제외합니다. 이 옵션은 모든 포함 옵션을 재정의합니다. 이 옵션은 부정 --include 된 옵션과 호환되지 않습니다.

`--size-limit=<bytes>`

크기가 지정된 제한을 초과하는 모든 파일을 제외합니다. 크기 제한은 "k" 접미사가 있는 키비바이트(KiB) 바이트, "m" 접미사가 있는 Mebibytes(MiB) 및 "g" 접미사가 있는 gibibytes(GiB)입니다. 이 옵션은 모든 포함 옵션을 재정의합니다.

`--total-size-limit=<bytes>`

확인된 모든 파일의 결합된 크기가 지정된 제한을 초과하는 경우 명령이 오류와 함께 종료되도록 합니다. 크기 제한은 "k" 접미사가 있는 키비바이트(KiB) 바이트, "m" 접미사가 있는 Mebibytes(MiB) 및 "g" 접미사가 있는 gibibytes(GiB)입니다.