이 콘텐츠는 CodeQL CLI의 최신 릴리스에 대해 설명합니다. 이 릴리스에 대한 자세한 내용은 를 참조하세요 https://github.com/github/codeql-cli-binaries/releases.
이전 릴리스에서 이 명령에 사용할 수 있는 옵션에 대한 세부 정보를 보려면 터미널에서 옵션을 사용하여 명령을 --help 실행합니다.
개요
codeql generate query-help --format=<format> [--output=<dir|file>] <options>... -- <qhelp|query|dir|suite>...Description
.qhelp 파일에서 최종 사용자 쿼리 도움말을 생성합니다.
기본 옵션
<qhelpdir|suite>...
[필수] 렌더링할 도움말 파일을 쿼리합니다. 각 인수는 다음 중 하나입니다.
- 렌더링할 .qhelp 파일입니다.
- 렌더링할 해당 .qhelp 파일이 있는 .ql 파일입니다.
- 해당 .qhelp 파일이 있는 .ql 파일을 재귀적으로 검색할 디렉터리입니다.
- 특정 쿼리 집합을 정의하는 .qls 파일입니다.
- 설치된 QL 팩 중 하나에서 내보낸 "잘 알려진" .qls 파일의 기본 이름입니다.
--format=<format>
[필수] 설명서를 렌더링할 형식입니다. 다음 중 하나:
markdown: GitHub 버전 마크다운.
sarif-latest: 정적 분석 결과를 설명하기 위한 JSON 기반 형식인 SARIF(정적 분석 결과 교환 형식)입니다. 이 형식 옵션은 가장 최근에 지원되는 버전(v2.1.0)을 사용합니다. 이 옵션은 서로 다른 CodeQL 버전 간에 서로 다른 버전의 SARIF를 생성하기 때문에 자동화에 사용하기에 적합하지 않습니다.
sarifv2.1.0: SARIF v2.1.0.
-o, --output=<dir|file>
렌더링된 설명서를 작성할 경로입니다. 일반적으로 렌더링된 출력이 기록되는 디렉터리입니다.
단일 .qhelp 또는 .ql 파일만 제공되고 출력 경로에 디렉터리가 없는 경우 출력은 해당 경로의 단일 파일에 기록됩니다.
출력 경로가 제공되지 않으면 단일 .qhelp 또는 .ql 파일만 수락되고 출력은 stdout에 기록됩니다.
출력 디렉터리를 사용하는 경우 출력 디렉터리 내 의 파일 이름은 .qhelp 파일 이름에서 파생됩니다.
--warnings=<mode>
쿼리 도움말 렌더러에서 경고를 처리하는 방법입니다. 다음 중 하나:
hide: 경고를 표시하지 않습니다.
show(기본값): 경고를 인쇄하지만 렌더링을 계속합니다.
error: 경고를 오류로 처리합니다.
QL 팩 찾기 옵션(쿼리 도구 모음을 resolve 데 필요할 수 있음)
--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>=\
예를 들어 를 전달할 수 있습니다. 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 환경 변수가 재정의됩니다.
일반 옵션
-h, --help
이 도움말 텍스트를 표시합니다.
-J=<opt>
[고급] 명령을 실행하는 JVM에 옵션을 제공합니다.
(공백이 포함된 옵션이 올바르게 처리되지 않도록 주의하세요.)
-v, --verbose
인쇄되는 진행률 메시지 수를 증분 방식으로 늘입니다.
-q, --quiet
인쇄되는 진행률 메시지 수를 증분 방식으로 줄입니다.
--verbosity=<level>
[고급] 세부 정보 표시 수준을 오류, 경고, 진행률, progress+, progress++, progress+++ 중 하나로 명시적으로 설정합니다. -v 및 -q를 재정의합니다.
--logdir=<dir>
[고급] 타임스탬프와 실행 중인 하위 명령의 이름을 포함하는 생성된 이름을 사용하여 지정된 디렉터리의 하나 이상의 파일에 자세한 로그를 씁니다.
(모든 권한을 가진 이름으로 로그 파일을 작성하려면 대신 stderr를 원하는 대로 지정 --log-to-stderr 하고 리디렉션합니다.)