팩 설치

개요

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

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

설명

이 팩의 종속성을 설치합니다.

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

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

옵션

기본 옵션

<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

[고급] strict 모드를 비활성화하여 --additional-packs

및 기타 로컬로 확인된 위치에서 패키지를 확인할 때 경고를 방지합니다. 로컬로 확인된 패키지는 다운로드되지 않으며

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

--mode=<mode>

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

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

upgrade: qlpack.yml 파일의 제약 조건에 따라 모든 종속성의 최신 버전을 사용하도록 codeql-pack.lock.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: [사용되지 않음] qlpack.yml 파일의 제약 조건에 따라 모든 종속성의 최신 버전을 사용하도록 codeql-pack.lock.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

쉼표로 구분된 <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부터 사용할 수 있습니다.