쿼리 확인

개요

codeql resolve queries <options>... -- <query|dir|suite|pack>...

codeql resolve queries <options>... -- <query|dir|suite|pack>...

설명

[심층 연결] 쿼리 디렉터리 및 도구 모음 사양을 확장합니다.

이 연결 명령은 여러 쿼리를 실행할 수 있는 하위 명령의 명령줄 매개 변수를 실행할 개별 .ql 파일의 실제 목록으로 확장하는 역할을 합니다.

인수 없이 실행하면 사용 가능한 QL 팩에 있는 "잘 알려진" 쿼리 도구 모음 정의 목록을 포함한 도움말 메시지를 표준 오류 스트림에 표시하고 빈 쿼리 목록을 반환합니다.

옵션

기본 옵션

<querysuite|pack>...

[필수] 실행할 쿼리입니다. 각 인수는 scope/name@range:path 형식입니다.

• scope/name은 CodeQL 팩의 정규화된 이름입니다.
• range는 semver 범위입니다.
• path는 파일 시스템 경로입니다.

scope/name을 지정하면 range 및 path는 선택 사항입니다. 누락된 range는 지정된 팩의 최신 버전을 의미합니다. 누락된 path는 지정된 팩의 기본 쿼리 도구 모음을 의미합니다.

path는 *.ql 쿼리 파일, 하나 이상의 쿼리가 포함된 디렉터리 또는 .qls 쿼리 도구 모음 파일 중 하나일 수 있습니다. 지정된 팩 이름이 없으면 path를 제공해야 하며 현재 프로세스의 현재 작업 디렉터리를 기준으로 해석됩니다.

리터럴 @ 또는 :을 포함하는 path를 지정하려면 path:directory/with:and@/chars와 같이 인수의 접두사로 path:를 사용합니다.

scope/name과 path를 지정하면 path는 절댓값이 될 수 없습니다. CodeQL 팩의 루트에 상대적인 것으로 간주됩니다.

--format=<fmt>

출력 형식을 선택합니다. 다음을 선택할 수 있습니다.

text (기본값): 경로 이름의 줄 지향 목록입니다.

json: 문자열로 된 경로 이름의 일반 목록입니다.

bylanguage: 라이브러리 종속성에서 추론된 대로 작업하는 추출기를 기준으로 쿼리를 그룹화하는 보다 풍부한 JSON 표현입니다. 컴퓨팅 비용이 약간 더 많이 듭니다.

installedpacks: [심층 연결] 직접 또는 쿼리 도구 모음 내에서 참조되고 로컬에서 사용할 수 없는 CodeQL 쿼리 팩을 나열하는 JSON 표현입니다.

QL 팩을 찾기 위한 옵션(쿼리 도구 모음을 해석하는 데 필요할 수 있음)

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

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

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

오픈 소스 CodeQL 리포지토리의 체크 아웃에서 이를 가리키면 해당 리포지토리에 있는 언어 중 하나를 쿼리할 때 작동해야 합니다.

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

(참고: Windows에서는 경로 구분 기호가 ;입니다.)

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

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

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

(참고: Windows에서는 경로 구분 기호가 ;입니다.)

CodeQL 패키지 관리자를 구성하는 옵션

--registries-auth-stdin

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

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

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

이렇게 하면 GITHUB_TOKEN 환경 변수가 재정의됩니다.

일반 옵션

-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부터 사용할 수 있습니다.