Skip to main content

diagnostic add

[실험적] [연결] 진단 정보를 추가합니다.

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

GitHub CodeQL은(는) 설치 시 사용자별로 라이선스가 부여됩니다. 라이선스 제한에 따라 특정 작업에만 CodeQL을(를) 사용할 수 있습니다. 자세한 내용은 "CodeQL CLI 알아보기"을(를) 참조하세요.

GitHub Advanced Security 라이선스가 있는 경우 CodeQL을(를) 사용하여 분석 자동화, 연속 통합 및 지속적인 업데이트를 할 수 있습니다. 자세한 내용은 "GitHub Advanced Security 정보.

이 문서의 내용

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

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

개요

Shell
codeql diagnostic add (--diagnostic-dir=<diagnosticDir>) --source-id=<id> --source-name=<name> <options>...

설명

[실험적] [연결] 진단 정보를 추가합니다.

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

옵션

기본 옵션

--markdown-message=<markdownMessage>

진단 메시지(GitHub Flavored Markdown 형식)입니다.

--plaintext-message=<plaintextMessage>

진단 메시지(일반 텍스트)입니다. 이 옵션은 --markdown-message를 사용하여 Markdown 메시지를 채우는 것이 실용적이지 않은 경우에만 사용해야 합니다.

--severity=<severity>

진단의 심각도입니다. "error", "warning" 또는 "note"일 수 있습니다.

진단 관련 도움말 링크입니다.

--attributes-json=<attributesJson>

진단과 관련된 구조화된 메타데이터입니다.

진단 정보의 저장 위치를 지정하는 옵션

다음 옵션 중 하나만 지정해야 합니다.

--diagnostic-dir=<diagnosticDir>

진단을 추가해야 하는 디렉터리입니다.

진단 메시지를 표시할 수 있는 위치를 나타내는 옵션

--ready-for-status-page

진단이 상태 페이지에 표시하기에 적합함을 나타냅니다.

--ready-for-cli-summary-table

진단이 database analyze와 같은 명령으로 출력한 진단 요약 테이블에 표시하기에 적합함을 나타냅니다.

진단 원본을 설명하는 옵션

--source-id=<id>

[필수] 이 진단의 원본에 대한 식별자입니다.

--source-name=<name>

[필수] 이 진단의 원본에 대한 사람이 읽을 수 있는 설명입니다.

--extractor-name=<extractorName>

CodeQL 추출기에서 이 진단을 생성한 경우 CodeQL 추출기의 이름입니다.

진단 위치를 설명하는 옵션

--file-path=<file>

원본 루트를 기준으로 진단이 적용되는 파일의 경로입니다.

--start-line=<startLine>

진단 위치가 시작되는 1 기준 줄 번호(포함)입니다.

--start-column=<startColumn>

진단 위치가 시작되는 1 기준 열 번호(포함)입니다.

--end-line=<endLine>

진단 위치가 끝나는 1 기준 줄 번호(포함)입니다.

--end-column=<endColumn>

진단 위치가 끝나는 1 기준 열 번호(포함)입니다.

일반 옵션

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