쿼리 resolve

개요

codeql resolve queries <options>... -- <query|dir|suite|pack>...

Description

[심층 배관] 쿼리 디렉터리 및 제품군 사양을 확장합니다.

이 배관 명령은 여러 쿼리를 실행할 수 있는 하위 명령의 명령줄 매개 변수를 실행할 개별 .ql 파일의 실제 목록으로 확장하는 작업을 담당합니다.

인수 없이 실행하는 경우 은 사용 가능한 QL 팩에 있는 "잘 알려진" 쿼리 도구 모음 정의 목록을 포함한 도움말 메시지를 표준 오류 스트림에 표시하고 빈 쿼리 목록을 성공적으로 반환합니다.

기본 옵션

<querysuite|pack>...

[필수] 실행할 쿼리입니다. 각 인수는 다음과 같은 형식 scope/name@range:path 입니다.

• scope/name 는 CodeQL 팩의 정규화된 이름입니다.
• range 는 셈버 범위입니다.
• path 는 파일 시스템 경로입니다.

가 scope/name 지정된 경우 및 path 는 range 선택 사항입니다. 누락 range 은 지정된 팩의 최신 버전을 의미합니다. 누락 path 은 지정된 팩의 기본 쿼리 제품군을 의미합니다.

은 path 쿼리 파일, 하나 이상의 쿼리를 포함하는 디렉터리 또는 .qls 쿼리 도구 모음 파일 중 하나 *.ql 일 수 있습니다. 지정된 팩 이름이 없으면 을 path 제공해야 하며 현재 프로세스의 현재 작업 디렉터리를 기준으로 해석됩니다.

리터럴 @ 또는 :를 포함하는 을 지정 path 하려면 인수의 접두사로 를 path:directory/with:and@/chars사용합니다path:.

및 path 가 scope/name 지정된 경우 는 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

쉼표로 구분된 쌍 목록을 \<registry_url>=\ 전달하여 GitHub Enterprise Server Container 레지스트리에 인증합니다.

예를 들어 를 전달할 수 있습니다. https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2 두 개의 GitHub Enterprise Server 인스턴스에 인증합니다.

이렇게 하면 CODEQL_REGISTRIES_AUTH 및 GITHUB_TOKEN 환경 변수가 재정의됩니다. github.com Container Registry에만 인증해야 하는 경우 더 --github-auth-stdin 간단한 옵션을 사용하여 인증할 수 있습니다.

--github-auth-stdin

표준 입력을 통해 github.com GitHub 앱 토큰 또는 개인용 액세스 토큰을 전달하여 github.com Container 레지스트리에 인증합니다.

GitHub Enterprise Server Container Registries에 인증하려면 CODEQL_REGISTRIES_AUTH 환경 변수를 전달 --registries-auth-stdin 하거나 사용합니다.

그러면 GITHUB_TOKEN 환경 변수가 재정의됩니다.

일반 옵션

-h, --help

이 도움말 텍스트를 표시합니다.

-J=<opt>

[고급] 명령을 실행하는 JVM에 옵션을 제공합니다.

(공백을 포함하는 옵션이 올바르게 처리되지 않도록 주의하세요.)

-v, --verbose

인쇄된 진행률 메시지 수를 증분 방식으로 늘입니다.

-q, --quiet

인쇄되는 진행률 메시지 수를 증분 방식으로 줄입니다.

--verbosity=<level>

[고급] 세부 정보 수준을 오류, 경고, 진행률, progress+, progress++, progress++, progress++중 하나로 명시적으로 설정합니다. -v 및 -q를 재정의합니다.

--logdir=<dir>

[고급] 타임스탬프와 실행 중인 하위 명령의 이름을 포함하는 생성된 이름을 사용하여 지정된 디렉터리의 하나 이상의 파일에 자세한 로그를 씁니다.

(이름을 가진 로그 파일을 작성하려면 모든 권한을 부여 --log-to-stderr 하고 원하는 대로 stderr를 리디렉션합니다.)