라이브러리-경로 해결

[심층 내부 처리] 쿼리에 사용할 QL 라이브러리 경로와 dbscheme를 결정합니다.

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

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

이 문서의 내용

참고 항목

이 콘텐츠는 CodeQL CLI의 최신 릴리스에 대해 설명합니다. 이 요소에 대한 자세한 내용은 http://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> 쌍 목록을 전달합니다.

예를 들어, http://containers.GHEHOSTNAME1/v2/=TOKEN1,http://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 환경 변수를 재정의합니다.

컴파일할 대상을 지정하기 위한 옵션

이 옵션들 중 정확히 하나를 반드시 지정해야 합니다.

--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>

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

--logdir=<dir>

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

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

--common-caches=<dir>

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

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