쿼리 도움말 생성

참고 항목

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

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

개요

Shell

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

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

Description

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

Options

기본 옵션

`<qhelp|mdhelp|query|dir|suite>...`

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

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

`--format=<format>`

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

          `markdown`: GitHub flavored markdown.

          `sarif-latest`: SARIF(정적 분석 결과 교환 형식)는 정적 분석 결과를 설명하기 위한 JSON 기반 형식입니다. 이 형식 옵션은 지원되는 최신 버전인 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`

GitHub Enterprise Server 컨테이너 레지스트리 인증을 위해 쉼표로 구분된 <registry_url>=<token> 쌍 목록을 전달합니다.

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

이는 CODEQL_REGISTRIES_AUTH 및 GITHUB_TOKEN 환경 변수를 재정의합니다. GitHub 컨테이너 레지스트리에 인증만 필요한 경우 --github-auth-stdin 옵션을 사용하여 간편하게 인증할 수 있습니다.

`--github-auth-stdin`

GitHub 앱 토큰 또는 개인 액세스 토큰을 사용하여 표준 입력으로 github.com 컨테이너 레지스트리에 인증합니다.

GitHub Enterprise Server 컨테이너 레지스트리에 인증하려면 --registries-auth-stdin 를 전달하거나 CODEQL_REGISTRIES_AUTH 환경 변수를 사용하세요.

이는 GITHUB_TOKEN 환경 변수를 재정의합니다.

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

(옵션에 공백이 포함될 경우 처리가 정상적으로 이루어지지 않을 수 있으니 주의가 필요합니다.)

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

`--logdir=<dir>`

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

(로그 파일 이름을 직접 지정하려면 대신 --log-to-stderr 를 사용하고 stderr를 원하는 위치로 리디렉션하세요.)

`--common-caches=<dir>`

          \[고급] 다운로드한 QL 팩과 컴파일된 쿼리 계획 등, CLI를 여러 번 실행해도 유지되는 디스크에 캐시된 데이터의 위치를 제어합니다. 명시적으로 설정하지 않으면, 기본적으로 사용자의 홈 디렉터리에 지정된 `.codeql` 이름의 디렉터리로 설정됩니다. 디렉터리가 아직 존재하지 않는 경우, 새로 생성됩니다.

v2.15.2부터 사용할 수 있습니다.

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

이 문서의 내용

개요