pack install

참고 항목

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

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

개요

Shell

codeql pack install [--force] <options>... -- <dir>

codeql pack install [--force] <options>... -- <dir>

이 명령은 팩에 대한 종속성을 설치합니다. codeql-pack.lock.yml이 존재하는 경우, 해당 잠금 파일에 지정된 버전이 qlpack.yml 파일에 지정된 버전 제약 조건을 충족하면 해당 버전으로 설치됩니다. 잠금 파일에 지정된 종속성 버전이 이 팩의 제약 조건을 충족하지 않는 경우, 이 명령은 각 종속성에 대한 최신 호환 버전을 설치하며 잠금 파일을 새로 선택한 버전으로 업데이트합니다. 잠금 파일이 없으면 이 명령은 모든 종속성에 대한 최신 호환 버전을 설치하며 새 잠금 파일을 만듭니다.

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

Options

기본 옵션

`<dir>`

패키지의 루트 디렉터리입니다.

`--format=<fmt>`

text(기본값) 또는 json 중에서 출력 형식을 선택합니다.

`-f, --[no-]force`

이미 존재하는 팩을 덮어쓰도록 허용합니다.

`--[no-]allow-prerelease`

사전 릴리스 버전 한정자(예: X.Y.Z-qualifier)가 있는 팩을 사용하도록 허용합니다. 이 플래그가 없는 경우 사전 릴리스 팩은 무시됩니다.

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

`--lock-override=<file>`

          \[고급] 종속성 해결의 입력으로 사용할 대체 잠금 파일을 지정합니다.

`--lock-output=<file>`

          \[고급] 종속성 확인으로 생성된 잠금 파일을 저장할 대체 위치를 지정합니다.

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

`--no-strict-mode`

          \[고급] `--additional-packs` 및 기타 로컬 확인 위치에서 패키지를 확인할 때 경고가 발생하지 않도록 하려면

strict 모드를 끕니다. 로컬로 확인된 패키지는 다운로드되지 않으며

패키지 잠금에 추가되지 않습니다.

`--mode=<mode>`

          \[사용되지 않음] 종속성 확인 방법을 지정합니다.

          `minimal-update`              _(기본값)_: qlpack.yml 파일의 기존 내용을 기반으로 codeql-pack.lock.yml을 업데이트하거나 만듭니다. 기존 codeql-pack.lock.yml이 qlpack.yml의 현재 종속성을 충족하지 않는 경우 잠금 파일이 필요에 따라 업데이트됩니다.

          `upgrade`: codeql-pack.lock.yml을 업데이트하거나 만들어서 qlpack.yml 파일의 제약 조건에 따라 모든 종속성의 최신 버전을 사용합니다. 이 모드는 'codeql pack upgrade' 명령에 의해 대체되었습니다.

          `verify`: 기존 codeql-pack.lock.yml이 qlpack.yml에 지정된 종속성과 여전히 유효한지 확인하고, 잠금 파일이 없는 경우 실패합니다. 이 모드는 'codeql pack ci' 명령에 의해 대체되었습니다.

          `no-lock`: 기존 codeql-pack.lock.yml을 무시한 다음, qlpack.yml 파일을 기반으로 확인을 수행합니다. 잠금 파일을 만들거나 업데이트하지 않습니다.

          `use-lock`: 기존 codeql-pack.lock.yml 파일을 사용하여 종속성을 확인하거나, 잠금 파일이 없는 경우 잠금 파일을 만듭니다.

          `update`: \[사용되지 않음] codeql-pack.lock.yml을 업데이트하거나 만들어서 qlpack.yml 파일의 제약 조건에 따라 모든 종속성의 최신 버전을 사용합니다. 이 모드는 'codeql pack upgrade' 명령에 의해 대체되었습니다.

패키지 레지스트리 외부의 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.com 컨테이너 레지스트리 인증만 필요한 경우 --github-auth-stdin 옵션을 사용하여 간편하게 인증할 수 있습니다.

`--github-auth-stdin`

GitHub Apps 토큰 또는 개인용 액세스 토큰을 github.com에 전달하여 표준 입력을 통해 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부터 사용할 수 있습니다.

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

이 문서의 내용

개요

Description