쿼리 해결

[심층 내부 처리] 쿼리 디렉터리와 스위트 사양을 확장합니다.

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

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

--github-auth-stdin

표준 입력을 통해 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>

          \[고급] 상세 수준을 명시적으로 설정합니다. 선택 가능한 값: errors, warnings, progress, progress+, progress++, progress+++. 
          `-v` 및 `-q`를 재정의합니다.

--logdir=<dir>

          \[고급] 지정된 디렉토리에 자세한 로그를 하나 이상 기록합니다. 로그 파일 이름에는 타임스탬프와 실행 중인 하위 명령 이름이 포함됩니다.

(로그 파일 이름을 완전히 제어하고 싶다면, 대신 --log-to-stderr을 사용하고 원하는 대로 stderr를 리디렉션하세요.)

--common-caches=<dir>

          \[고급] CLI의 여러 실행 간에 유지되는 디스크상의 캐시 데이터 위치를 제어합니다. 여기에는 다운로드된 QL 팩과 컴파일된 쿼리 계획이 포함됩니다. 명시적으로 설정하지 않은 경우, 사용자 홈 디렉터리에 있는 `.codeql`이라는 이름의 디렉터리를 기본값으로 사용하며, 해당 디렉터리가 존재하지 않으면 새로 생성됩니다.

v2.15.2부터 사용할 수 있습니다.