라이브러리 경로 확인

개요

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

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

설명

[심층 연결] 쿼리에 대한 QL 라이브러리 경로 및 dbscheme을 확인합니다.

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

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

이 명령은 내부에서 심층적으로 작동하며 QL 언어 에코시스템이 발전함에 따라 그 동작이나 존재가 예고 없이 변할 수 있습니다.

옵션

기본 옵션

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

쉼표로 구분된 <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 환경 변수가 재정의됩니다.

컴파일할 내용을 지정하는 옵션

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

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