쿼리 도움말 생성

데이터 재사용 코드ql-cli.man-pages-version-note %}

개요

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 특화 마크다운.

          `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> 쌍 목록을 전달합니다.

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

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

`--github-auth-stdin`

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

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

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

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

(공백이 포함된 옵션은 올바르게 처리되지 않을 수 있습니다.)

          \[고급] 상세 수준을 명시적으로 설정합니다. 선택 가능한 값: errors, warnings, progress, progress+, progress++, progress+++. 
          `-v` 및 `-q`를 재정의합니다.

`--logdir=<dir>`

          \[고급] 지정된 디렉토리에 자세한 로그를 하나 이상 기록합니다. 로그 파일 이름에는 타임스탬프와 실행 중인 하위 명령 이름이 포함됩니다.

(로그 파일 이름을 완전히 제어하고 싶다면, 대신 --log-to-stderr을 사용하고 원하는 대로 stderr를 리디렉션하세요.)

`--common-caches=<dir>`

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

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

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

이 기사에서

개요