generate query-help

.qhelp 파일에서 최종 사용자 쿼리 도움말을 생성합니다.

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

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

이 문서의 내용

Note

이 콘텐츠는 CodeQL CLI의 최신 릴리스에 대해 설명합니다. 이 요소에 대한 자세한 내용은 https://github.com/github/codeql-cli-binaries/releases을(를) 참조하세요.

이전 릴리스에서 이 명령에 사용할 수 있는 옵션의 세부 정보를 보려면 터미널에서 옵션을 사용하여 --help 명령을 실행합니다.

개요

Shell
codeql generate query-help --format=<format> [--output=<dir|file>] <options>... -- <qhelp|mdhelp|query|dir|suite>...

설명

.qhelp 파일에서 최종 사용자 쿼리 도움말을 생성합니다.

옵션

기본 옵션

<qhelpquerysuite>...

[필수] 렌더링할 도움말 파일을 쿼리합니다. 각 인수는 다음 중 하나입니다.

  • 렌더링할 .qhelp 파일입니다.
  • 렌더링할 .md 파일입니다.
  • 렌더링할 해당 .qhelp 파일 또는 .md 파일이 있는 .ql 파일입니다.
  • 해당 .qhelp 파일 또는 .md 파일이 있는 .ql 파일을 재귀적으로 검색할 디렉터리입니다.
  • 특정 쿼리 집합을 정의하는 .qls 파일입니다.
  • 설치된 QL 팩 중 하나에서 내보낸 "잘 알려진" .qls 파일의 basename입니다.

--format=<format>

[필수] 설명서를 렌더링할 형식입니다. 다음 중 하나입니다.

markdown: GitHub Flavored Markdown입니다.

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: 경고를 오류로 처리합니다.

--no-sarif-minify

[SARIF 형식만] 자동 서식 지정 SARIF 출력을 생성합니다. 기본적으로 SARIF 출력은 출력 파일의 크기를 줄이기 위해 축소됩니다.

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>=<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 환경 변수가 재정의됩니다.

일반 옵션

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