이 콘텐츠는 CodeQL CLI의 최신 릴리스에 대해 설명합니다. 이 릴리스에 대한 자세한 내용은 를 참조하세요 https://github.com/github/codeql-cli-binaries/releases.
이전 릴리스에서 이 명령에 사용할 수 있는 옵션에 대한 세부 정보를 보려면 터미널에서 옵션을 사용하여 명령을 --help 실행합니다.
개요
codeql resolve library-path (--query=<qlfile> | --dir=<dir> | --root-pack=<pkgname>) <options>...설명
[심층 배관] 쿼리에 대한 QL 라이브러리 경로 및 dbscheme을 결정합니다.
특정 쿼리를 컴파일해야 하는 QL 라이브러리 경로를 결정합니다. 이 계산은 쿼리를 컴파일해야 할 수 있는 여러 하위 명령에서 암시적입니다. (a) 문제 해결에 도움이 되도록 별도의 배관 명령으로 노출되며(b) 정확한 제어가 필요한 특별한 경우에 경로를 수정하기 위한 시작점을 제공합니다.
또한 명령은 쿼리를 컴파일하는 언어 및 dbscheme도 검색합니다. 이는 QL 쿼리의 언어 자동 정의에도 따라 달라질 수 있기 때문에 쿼리를 컴파일합니다.
명령은 내부적으로 심층적으로 작동하며 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>=\
예를 들어 를 전달할 수 있습니다. https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2
두 개의 GitHub Enterprise Server 인스턴스에 인증합니다.
이렇게 하면 CODEQL_REGISTRIES_AUTH 및 GITHUB_토큰 환경 변수가 재정의됩니다. github.com Container Registry에만 인증해야 하는 경우 더 --github-auth-stdin 간단한 옵션을 사용하여 인증할 수 있습니다.
--github-auth-stdin
표준 입력을 통해 github.com GitHub 앱 토큰 또는 개인용 액세스 토큰을 전달하여 github.com Container Registry에 인증합니다.
GitHub Enterprise Server Container Registries에 인증하려면 CODEQL_REGISTRIES_AUTH 환경 변수를 전달 --registries-auth-stdin 하거나 사용합니다.
그러면 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>
[고급] 세부 정보 표시 수준을 오류, 경고, 진행률, progress+, progress++, progress+++ 중 하나로 명시적으로 설정합니다. -v 및 -q를 재정의합니다.
--logdir=<dir>
[고급] 타임스탬프와 실행 중인 하위 명령의 이름을 포함하는 생성된 이름을 사용하여 지정된 디렉터리의 하나 이상의 파일에 자세한 로그를 씁니다.
(모든 권한을 가진 이름으로 로그 파일을 작성하려면 대신 stderr를 원하는 대로 지정 --log-to-stderr 하고 리디렉션합니다.)