resolve queries

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

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

CodeQL은(는) 다음 리포지토리 유형에 사용할 수 있습니다.

이 문서의 내용

참고 항목

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

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

개요

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

Description

          \[심층 내부 처리] 쿼리 디렉터리 및 도구 모음 사양을 확장합니다.

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

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

Options

기본 옵션

<query|dir|suite|pack>...

          \[필수] 실행할 쿼리입니다. 각 인수는 `scope/name@range:path` 형식으로 되어 있습니다. 여기서,

  •           `scope/name`은 CodeQL 팩의 정규화된 이름입니다.

  •           `range`는 semver 범위입니다.

  •           `path`는 파일 시스템 경로입니다.

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

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

리터럴 @ 또는 :이 포함된 path를 지정하려면 인수에 path:를 접두사로 사용합니다(예: path:directory/with:and@/chars).

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

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

--github-auth-stdin

GitHub Apps 토큰 또는 개인용 액세스 토큰을 github.com에 전달하여 표준 입력을 통해 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부터 사용할 수 있습니다.