라이브러리-경로 해결

[심층 내부 처리] 쿼리에 대한 QL 라이브러리 경로와 dbscheme을 결정합니다.

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

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

이 문서의 내용

참고 항목

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

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

개요

Shell
codeql resolve library-path (--query=<qlfile> | --dir=<dir> | --root-pack=<pkgname>) <options>...

Description

          \[심층 내부 처리] 쿼리에 대한 QL 라이브러리 경로와 dbscheme을 결정합니다.

특정 쿼리를 어떤 QL 라이브러리 경로를 기준으로 컴파일할지 결정합니다. 이 계산은 쿼리를 컴파일해야 하는 여러 하위 명령어에서 암묵적으로 수행됩니다. 이는 별도의 내부 처리 명령으로 노출되며, (a) 문제 해결에 도움을 주고 (b) 정확한 제어가 필요한 특별한 경우 경로 수정을 위한 시작점을 제공하기 위함입니다.

이 명령은 쿼리를 컴파일하는 언어 및 dbscheme도 검색합니다. QL 쿼리 언어의 자동 검색에 따라서도 달라질 수 있기 때문입니다.

          **내부에서 심층적으로 작동하는 이 명령은 QL 언어 에코시스템의 발전에 따라 예고 없이 해당 동작이나 존재가 변경될 수 있습니다.**

Options

기본 옵션

--[no-]find-extractors

          \[고급] 출력에 쿼리가 의존하는 QL 팩의 `extractor` 필드 요약을 포함시킵니다. 이는 일부 드문 내부 용도로만 사용되며, 컴퓨팅에 더 많은 작업이 필요할 수 있으므로 기본적으로 활성화되어 있지 않습니다.

--format=<fmt>

출력 서식을 선택합니다. 옵션 포함 사항:

          `lines`              _(기본값)_: 각각 한 줄로 명령줄 인수를 인쇄합니다.

          `json`: 데이터 전체를 포함하는 JSON 개체를 인쇄합니다.

          `path`: 계산된 라이브러리 경로만 인쇄합니다.

          `dbscheme`: 감지된 dbscheme만 인쇄합니다.

          `cache`: 기본 컴파일 캐시 위치를 인쇄합니다. 기본 컴파일 캐시 위치가 없는 경우에는 아무 것도 인쇄하지 않습니다.

호출한 명령의 명령줄의 옵션

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

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

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

이를 오픈 소스 CodeQL 리포지토리의 체크 아웃 위치로 지정하면, 해당 리포지토리에 있는 언어 중 하나를 쿼리할 때 정상적으로 동작합니다.

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

(참고: Windows에서는 경로 구분 기호로 ;을(를) 사용합니다.)

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

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

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

(참고: Windows에서는 경로 구분 기호로 ;을(를) 사용합니다.)

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

          \[고급] QL 라이브러리의 원시 가져오기 검색 경로에 추가되는 디렉터리의 선택적 목록입니다. QL 팩으로 패키지되지 않은 QL 라이브러리를 사용 중인 경우에 한해 사용 가능합니다.

(참고: Windows에서는 경로 구분 기호로 ;을(를) 사용합니다.)

--dbscheme=<file>

          \[고급] 쿼리가 어떤 dbscheme에 대해 컴파일되어야 하는지 명시적으로 정의합니다. 작업 내용을 완전히 파악하고 있는 호출자에 한해서만 사용되어야 합니다.

--compilation-cache=<dir>

          \[고급] 컴파일 캐시로 사용하기 위한 추가 디렉터리를 지정합니다.

--no-default-compilation-cache

          \[고급] 표준 위치(예: 쿼리를 포함하는 QL 팩 또는 CodeQL 툴체인 디렉터리)에서 컴파일 캐시를 사용하지 마세요.

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 컨테이너 레지스트리에 인증합니다.

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

이는 GITHUB_TOKEN 환경 변수를 재정의합니다.

컴파일하려는 사항을 지정하는 옵션

다음 옵션 중에서 하나의 옵션만 지정해야 합니다.

--query=<qlfile>

컴파일하려는 QL 파일의 경로입니다.

해당 디렉터리와 부모 디렉터리에서 qlpack.yml 파일이나 레거시 queries.xml 파일을 검색하여 필요한 팩을 결정합니다.

--dir=<dir>

컴파일할 쿼리를 포함하는 팩의 루트 디렉터리입니다.

--root-pack=<pkgname>

          \[고급] 종속성 해결의 루트로 사용할 팩의 선언된 이름입니다.

검색 경로에서 이름으로 팩을 찾을 수 있는 경우 이 기능이 사용됩니다. 원하는 루트 패키지의 _디스크 위치_를 알고 있다면 해당 위치에 .ql 파일이 포함된 것으로 가장하고 --query을(를) 대신 사용합니다.

일반 옵션

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