진단 추가

참고 항목

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

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

개요

Shell

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

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

Description

          \[실험적] \[내부 처리] 진단 정보를 추가합니다.

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

Options

기본 옵션

`--markdown-message=<markdownMessage>`

진단 메시지로, GitHub 스타일의 Markdown 형식입니다.

`--plaintext-message=<plaintextMessage>`

진단 메시지로, 일반 텍스트 형식입니다. 이 옵션은 --markdown-message로 Markdown 메시지를 작성하는 것이 실용적이지 않을 때만 사용해야 합니다.

`--severity=<severity>`

진단의 심각도입니다. 값으로는 "error", "warning", 또는 "note"를 사용할 수 있습니다.

`--help-link=<helpLinks>`

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

`--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>`

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

`--logdir=<dir>`

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

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

`--common-caches=<dir>`

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

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

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

이 문서의 내용

개요