sitelink1 | https://github.com/oss-review-toolkit/ort |
---|---|
sitelink2 | https://oss-review-toolkit.org/ort/ |
sitelink3 | |
sitelink4 | |
extra_vars5 | |
extra_vars6 |
"./ort/cli/build/install/ort/bin/ort --help-all" cmd 에 대한 내용이다.
네, 요청하신 대로 ORT(Open Source Review Toolkit)의 도움말에서 실행 옵션을 제외한 옵션 설명을 한국어로 번역하여 제공합니다.
Hoplite 구성 경고
Hoplite는 런타임에 구성 값을 검사하여 봉인된 유형(sealed type)을 선택하도록 추론합니다. 이 동작은 이제 사용되지 않으며, 판별자 필드를 통해 유형을 명시적으로 지정하는 것이 권장됩니다. 3.0 버전에서는 이 새로운 동작이 기본값이 됩니다. 이 동작을 지금 활성화하고 이 경고를 비활성화하려면, ConfigLoaderBuilder
에서 invokeWithExplicitSealedTypes()
를 호출하세요.
ort advise
보안 취약점에 대한 종속성을 확인합니다.
출력 옵션
- -o, --output-dir=<값>: 어드바이저 결과가 포함된 ORT 결과 파일을 작성할 디렉터리입니다.
- -f, --output-formats=(JSON|YAML): ORT 결과 파일에 사용될 출력 형식 목록입니다. (기본값: [YAML])
구성 옵션
- --resolutions-file=<값>: 문제 및 규칙 위반 해결책이 포함된 파일입니다. (기본값:
/home/tobesoft/.ort/config/resolutions.yml
)
옵션
- -i, --ort-file=<값>: 사용할 분석기 결과가 포함된 ORT 결과 파일입니다.
- -l, --label=<값>: ORT 결과에 레이블을 설정하여 동일한 이름의 기존 레이블을 덮어씁니다. 여러 번 사용할 수 있습니다. 예:
--label distribution=external
- -a, --advisors=<값>: 사용할 어드바이저를 쉼표로 구분하여 나열합니다. [BlackDuck, OSSIndex, OSV, VulnerableCode] 중 하나입니다.
- --skip-excluded: 제외된 프로젝트나 패키지를 확인하지 않습니다. (사용되지 않음)
- -h, --help: 이 메시지를 표시하고 종료합니다.
ort analyze
소프트웨어 프로젝트의 종속성을 파악합니다.
입력 옵션
- -i, --input-dir=<값>: 분석할 프로젝트 디렉터리입니다. 단일 패키지 관리자만 활성화된 경우 정의 파일을 가리킬 수도 있습니다.
출력 옵션
- -o, --output-dir=<값>: 분석기 결과가 포함된 ORT 결과 파일을 작성할 디렉터리입니다.
- -f, --output-formats=(JSON|YAML): ORT 결과 파일에 사용될 출력 형식 목록입니다. (기본값: [YAML])
구성 옵션
- --repository-configuration-file=<값>: 저장소 구성이 포함된 파일입니다. 설정된 경우 저장소 내 '.ort.yml' 파일에 포함된 모든 저장소 구성을 재정의합니다.
- --resolutions-file=<값>: 문제 및 규칙 위반 해결책이 포함된 파일입니다. (기본값:
/home/tobesoft/.ort/config/resolutions.yml
)
옵션
- -l, --label=<값>: ORT 결과에 레이블을 설정하여 동일한 이름의 기존 레이블을 덮어씁니다. 여러 번 사용할 수 있습니다. 예:
--label distribution=external
- --dry-run: 실제로 프로젝트 분석을 실행하지 않고, 사용될 패키지 관리자만 표시합니다.
- -h, --help: 이 메시지를 표시하고 종료합니다.
ort compare
다양한 방법으로 두 ORT 결과를 비교합니다.
옵션
- -m, --method=(SEMANTIC_DIFF|TEXT_DIFF): ORT 결과를 비교할 때 사용할 방법입니다. [SEMANTIC_DIFF, TEXT_DIFF] 중 하나여야 합니다. (기본값: TEXT_DIFF)
- -C, --context-size=<정수>: 수정된 라인의 컨텍스트에서 표시할 수정되지 않은 라인 수입니다. 통합 diff 출력에만 적용됩니다. (기본값: 7)
- -t, --ignore-time: 시간 차이를 무시합니다.
- -e, --ignore-environment: 환경 차이를 무시합니다.
- -d, --ignore-tmp-dir: 임시 디렉터리 차이를 무시합니다.
- -h, --help: 이 메시지를 표시하고 종료합니다.
인수
- <filea>: 비교할 첫 번째 ORT 결과 파일입니다.
- <fileb>: 비교할 두 번째 ORT 결과 파일입니다.
ort config
다양한 ORT 구성을 표시합니다.
옵션
- --show-default: 사용자 지정 구성이 없을 때 사용되는 기본 구성을 표시합니다.
- --show-active: 사용자 지정 구성을 포함하여 사용 중인 활성 구성을 표시합니다.
- --show-reference: 참조 구성을 표시합니다. 이 구성은 지원되는 모든 구성 옵션에 대한 예시 항목만 포함하므로 실제로 사용되지 않습니다.
- --check-syntax=<값>: 주어진 구성 파일의 구문을 확인합니다.
- -h, --help: 이 메시지를 표시하고 종료합니다.
ort download
원격 위치에서 소스 코드를 가져옵니다.
입력 옵션
- -i, --ort-file=<값>: 사용할 분석기 결과가 포함된 ORT 결과 파일입니다. 필요한 경우 소스 코드가 자동으로 다운로드됩니다.
--project-url
과 함께 사용할 수 없습니다. - --project-url=<값>: 다운로드할 프로젝트의 VCS(버전 관리 시스템) 또는 아카이브 URL입니다.
--ort-file
과 함께 사용할 수 없습니다. - --project-name=<텍스트>: 다운로드할 프로젝트의 식별 가능한 이름입니다.
--project-url
과 함께 사용됩니다.--ort-file
도 지정된 경우 무시됩니다. (기본값: 프로젝트 URL의 마지막 부분) - --vcs-type=<텍스트>:
--project-url
이 VCS를 가리키는 경우 VCS 유형입니다.--ort-file
도 지정된 경우 무시됩니다. (기본값: 프로젝트 URL을 쿼리하여 감지된 VCS 유형) - --vcs-revision=<텍스트>:
--project-url
이 VCS를 가리키는 경우 VCS 개정(리비전)입니다.--ort-file
도 지정된 경우 무시됩니다. (기본값: VCS의 기본 개정) - --vcs-path=<텍스트>:
--project-url
이 VCS를 가리키는 경우 체크아웃을 제한할 VCS 경로입니다.--ort-file
도 지정된 경우 무시됩니다. (기본값: 제한 없음, 즉 루트 경로가 체크아웃됨)
구성 옵션
- --license-classifications-file=<값>: 'config.yml' 파일에 포함된 범주가 지정된 경우 다운로드를 제한하는 데 사용되는 라이선스 분류가 포함된 파일입니다. 지정되지 않은 경우 모든 패키지가 다운로드됩니다. (기본값:
/home/tobesoft/.ort/config/license-classifications.yml
)
출력 옵션
- -o, --output-dir=<값>: 소스 코드를 다운로드할 출력 디렉터리입니다.
옵션
- --archive: 다운로드한 소스 코드를 ZIP 파일로 출력 디렉터리에 보관합니다.
--project-url
도 지정된 경우 무시됩니다. - --archive-all: 다운로드한 모든 소스 코드를 단일 ZIP 파일로 출력 디렉터리에 보관합니다.
--project-url
도 지정된 경우 무시됩니다. - --package-types=(PACKAGE|PROJECT): ORT 파일의 분석기 결과에서 다운로드를 제한할 패키지 유형을 쉼표로 구분한 목록입니다. (기본값: [PACKAGE, PROJECT])
- --package-ids=<텍스트>: ORT 파일의 분석기 결과에서 다운로드를 제한할 패키지 ID를 일치시키기 위한 정규 표현식의 쉼표로 구분된 목록입니다. 지정되지 않은 경우 모든 패키지가 다운로드됩니다.
- --skip-excluded: 제외된 프로젝트나 패키지를 다운로드하지 않습니다.
--ort-file
매개변수와 함께 사용할 때만 작동합니다. (사용되지 않음) - --dry-run: 실제로 아무것도 다운로드하지 않고, 모든 소스 코드 위치가 유효한지 확인합니다.
- -p, --max-parallel-downloads=<정수>: 발생할 최대 병렬 다운로드 수입니다. (기본값: 8)
- -h, --help: 이 메시지를 표시하고 종료합니다.
ort evaluate
정책 규칙에 대해 ORT 결과 파일을 평가합니다.
입력 옵션
- -i, --ort-file=<값>: 입력으로 읽을 ORT 결과 파일입니다.
출력 옵션
- -o, --output-dir=<값>: 평가 결과가 포함된 ORT 결과 파일을 작성할 디렉터리입니다. 출력 디렉터리가 지정되지 않으면 ORT 결과 파일은 작성되지 않으며, 종료 코드만 성공 또는 실패를 나타냅니다.
- -f, --output-formats=(JSON|YAML): ORT 결과 파일에 사용될 출력 형식 목록입니다. (기본값: [YAML])
구성 옵션
- --copyright-garbage-file=<값>: 불필요한 것으로 표시된 저작권 문구가 포함된 파일입니다. 이는 출력과 평가기 출력 간의 불일치를 유발할 수 있지만, 저작권 불필요 데이터를 테스트할 때 유용합니다. (기본값:
/home/tobesoft/.ort/config/copyright-garbage.yml
) - --license-classifications-file=<값>: 규칙 스크립트에 매개변수로 전달되는 라이선스 분류가 포함된 파일입니다. (기본값:
/home/tobesoft/.ort/config/license-classifications.yml
) - --package-configurations-dir=<값>: 패키지 구성 파일을 재귀적으로 검색하는 디렉터리입니다. 각 파일은 단일 패키지 구성만 포함해야 합니다. 이는 출력과 평가기 출력 간의 불일치를 유발할 수 있지만, 패키지 구성을 테스트할 때 유용합니다.
- --package-curations-file=<값>: 패키지 큐레이션이 포함된 파일입니다. 이는 주어진 ORT 결과 파일에 포함된 모든 패키지 큐레이션을 주어진 파일에 있는 큐레이션으로 대체하며, 활성화된 경우 저장소 구성의 큐레이션도 대체합니다.
- --package-curations-dir=<값>: 패키지 큐레이션 파일이 포함된 디렉터리입니다. 이는 주어진 ORT 결과 파일에 포함된 모든 패키지 큐레이션을 주어진 디렉터리에 있는 큐레이션으로 대체하며, 활성화된 경우 저장소 구성의 큐레이션도 대체합니다.
- --repository-configuration-file=<값>: 저장소 구성이 포함된 파일입니다. 설정된 경우 ORT 결과 입력 파일에 포함된 저장소 구성을 재정의합니다. 이는 출력과 이전 명령의 출력 간의 불일치를 유발할 수 있지만, 저장소 구성 변경을 테스트할 때 유용합니다.
- --resolutions-file=<값>: 문제 및 규칙 위반 해결책이 포함된 파일입니다. (기본값:
/home/tobesoft/.ort/config/resolutions.yml
)
옵션
- -r, --rules-file=<값>: 규칙이 포함된 스크립트 파일의 이름입니다.
- --rules-resource=<텍스트>: 규칙이 포함된 클래스패스의 스크립트 리소스 이름입니다.
- -l, --label=<값>: ORT 결과에 레이블을 설정하여 동일한 이름의 기존 레이블을 덮어씁니다. 여러 번 사용할 수 있습니다. 예:
--label distribution=external
- --check-syntax: 스크립트를 평가하지 않고 구문만 확인합니다. 이 경우 출력은 작성되지 않습니다.
- -h, --help: 이 메시지를 표시하고 종료합니다.
ort migrate
ORT 구성을 최신 ORT 버전으로 마이그레이션하는 데 도움을 줍니다.
옵션
- --hocon-to-yaml=<값>: 주어진 HOCON 구성 파일을 YAML로 간단히 변환하고 결과를 출력합니다.
- --nuget-ids=<값>: 큐레이션 및 구성의 NuGet 패키지 ID를 네임스페이스를 포함하는 새 형식으로 변환합니다.
- --pub-ids=<값>: 큐레이션 및 구성의 Pub 패키지 ID를 네임스페이스가 없는 새 형식으로 변환합니다.
- -h, --help: 이 메시지를 표시하고 종료합니다.
ort notify
ORT 결과를 기반으로 알림을 생성합니다.
입력 옵션
- -i, --ort-file=<값>: 입력으로 읽을 ORT 결과 파일입니다.
- -n, --notifications-file=<값>: 알림 규칙이 포함된 Kotlin 스크립트 파일의 이름입니다.
구성 옵션
- --resolutions-file=<값>: 문제 및 규칙 위반 해결책이 포함된 파일입니다. (기본값:
/home/tobesoft/.ort/config/resolutions.yml
)
옵션
- -l, --label=<값>: 알리미 스크립트에 전달되는 ORT 결과에 레이블을 설정하여 동일한 이름의 기존 레이블을 덮어씁니다. 여러 번 사용할 수 있습니다. 예:
--label distribution=external
- -h, --help: 이 메시지를 표시하고 종료합니다.
ort plugins
설치된 ORT 플러그인에 대한 정보를 출력합니다.
옵션
- --types=<텍스트>: 표시할 플러그인 유형을 쉼표로 구분한 목록입니다. (기본값: [advice-providers, commands, package-configuration-providers, package-curation-providers, package-managers, reporters, scanners, version-control-systems])
- -h, --help: 이 메시지를 표시하고 종료합니다.
ort report
분석기, 스캐너 및 평가기 결과를 다양한 형식으로 표시합니다.
입력 옵션
- -i, --ort-file=<값>: 사용할 ORT 결과 파일입니다.
출력 옵션
- -o, --output-dir=<값>: 생성된 보고서를 저장할 출력 디렉터리입니다.
- -f, --report-formats=<값>: 생성할 보고서 형식의 쉼표로 구분된 목록입니다. [AOSD2.0, AOSD2.1, CtrlXAutomation, CycloneDX, DocBookTemplate, EvaluatedModel, FossID, FossIdSnippet, HtmlTemplate, ManPageTemplate, Opossum, PdfTemplate, PlainTextTemplate, SpdxDocument, StaticHTML, TrustSource, WebApp] 중 하나입니다.
구성 옵션
- --copyright-garbage-file=<값>: 불필요한 것으로 표시된 저작권 문구가 포함된 파일입니다. 이는 출력과 평가기 출력 간의 불일치를 유발할 수 있지만, 저작권 불필요 데이터를 테스트할 때 유용합니다. (기본값:
/home/tobesoft/.ort/config/copyright-garbage.yml
) - --custom-license-texts-dir=<값>: 사용자 지정 라이선스 ID를 라이선스 텍스트에 매핑하는 디렉터리입니다. 라이선스 ID를 파일 이름으로 하여 라이선스당 하나의 텍스트 파일을 포함해야 합니다. 사용자 지정 라이선스 텍스트는 ID에 'LicenseRef-' 접두사가 있고 해당 라이선스 텍스트가 ORT에 알려지지 않은 경우에만 사용됩니다. (기본값:
/home/tobesoft/.ort/config/custom-license-texts
) - --how-to-fix-text-provider-script=<값>: 'HowToFixTextProvider' 인스턴스를 반환하는 Kotlin 스크립트의 경로입니다. 이 제공자는 ORT 문제에 대한 해결 방법 텍스트를 Markdown 형식으로 주입합니다. (기본값:
/home/tobesoft/.ort/config/reporter.how-to-fix-text-provider.kts
) - --license-classifications-file=<값>: 라이선스 분류가 포함된 파일입니다. 이는 출력과 평가기 출력 간의 불일치를 유발할 수 있지만, 라이선스 분류를 테스트할 때 유용합니다. (기본값:
/home/tobesoft/.ort/config/license-classifications.yml
) - --package-configurations-dir=<값>: 패키지 구성 파일을 재귀적으로 검색하는 디렉터리입니다. 각 파일은 단일 패키지 구성만 포함해야 합니다. 이는 출력과 평가기 출력 간의 불일치를 유발할 수 있지만, 패키지 구성을 테스트할 때 유용합니다.
- --refresh-resolutions: 해결된 구성 대신 전역 및 저장소 구성의 해결책을 사용합니다. 이는 출력과 평가기 출력 간의 불일치를 유발할 수 있지만, 해결책을 테스트할 때 유용합니다.
- --repository-configuration-file=<값>: 저장소 구성이 포함된 파일입니다. 설정된 경우 ORT 결과 입력 파일에 포함된 저장소 구성을 재정의합니다. 이는 출력과 이전 명령의 출력 간의 불일치를 유발할 수 있지만, 저장소 구성 변경을 테스트할 때 유용합니다.
- --resolutions-file=<값>: 문제 및 규칙 위반 해결책이 포함된 파일입니다. (기본값:
/home/tobesoft/.ort/config/resolutions.yml
)
옵션
- -O, --report-option=<값>: 보고서 형식별 옵션을 지정합니다. 키는 보고서 형식의 (대소문자를 구분하지 않는) 이름이며, 값은 임의의 키-값 쌍입니다. 예:
-O PlainTextTemplate=template.id=NOTICE_SUMMARY
- -h, --help: 이 메시지를 표시하고 종료합니다.
ort requirements
ORT에 필요한 명령줄 도구를 확인합니다.
옵션
- -h, --help: 이 메시지를 표시하고 종료합니다.
ort scan
외부 라이선스 / 저작권 스캐너를 실행합니다.
출력 옵션
- -o, --output-dir=<값>: 스캔 결과가 포함된 ORT 결과 파일을 작성할 디렉터리입니다.
- -f, --output-formats=(JSON|YAML): ORT 결과 파일에 사용될 출력 형식 목록입니다. (기본값: [YAML])
구성 옵션
- --resolutions-file=<값>: 문제 및 규칙 위반 해결책이 포함된 파일입니다. (기본값:
/home/tobesoft/.ort/config/resolutions.yml
)
옵션
- -i, --ort-file=<값>: 사용할 분석기 결과가 포함된 ORT 결과 파일입니다. 필요한 경우 소스 코드가 자동으로 다운로드됩니다.
- -l, --label=<값>: ORT 결과에 레이블을 설정하여 동일한 이름의 기존 레이블을 덮어씁니다. 여러 번 사용할 수 있습니다. 예:
--label distribution=external
- -s, --scanners=<값>: 사용할 스캐너를 쉼표로 구분한 목록입니다. 가능한 값: [Askalono, BoyterLc, DOS, FossId, Licensee, ScanCode, SCANOSS] (기본값: [org.ossreviewtoolkit.plugins.scanners.scancode.ScanCodeFactory@2c05ff9d])
- --project-scanners=<값>: 프로젝트의 소스 코드를 스캔하는 데 사용할 스캐너를 쉼표로 구분한 목록입니다. 기본적으로 프로젝트와 패키지는
--scanners
로 지정된 동일한 스캐너로 스캔됩니다. 가능한 값: [Askalono, BoyterLc, DOS, FossId, Licensee, ScanCode, SCANOSS] - --package-types=(PACKAGE|PROJECT): ORT 파일의 분석기 결과에서 스캔을 제한할 패키지 유형을 쉼표로 구분한 목록입니다. (기본값: [PACKAGE, PROJECT])
- --skip-excluded: 제외된 프로젝트나 패키지를 스캔하지 않습니다.
--ort-file
매개변수와 함께 사용할 때만 작동합니다. (사용되지 않음) - -h, --help: 이 메시지를 표시하고 종료합니다.
ort upload-curations
ORT 패키지 큐레이션을 ClearlyDefined에 업로드합니다.
입력 옵션
- -i, --input-file=<값>: 업로드할 패키지 큐레이션이 포함된 파일입니다.
옵션
- -s, --server=(PRODUCTION|DEVELOPMENT|LOCAL): 업로드할 ClearlyDefined 서버입니다. [PRODUCTION, DEVELOPMENT, LOCAL] 중 하나여야 합니다. (기본값: DEVELOPMENT)
- -h, --help: 이 메시지를 표시하고 종료합니다.
ort upload-result-to-postgres
ORT 결과를 PostgreSQL 데이터베이스에 업로드합니다.
입력 옵션
- -i, --ort-file=<값>: 입력으로 읽을 ORT 결과 파일입니다.
옵션
- --table-name=<텍스트>: 결과를 업로드할 테이블 이름입니다.
- --column-name=<텍스트>: ORT 결과를 저장할 JSONB 컬럼 이름입니다.
- --create-table: 테이블이 존재하지 않으면 생성합니다.
- -h, --help: 이 메시지를 표시하고 종료합니다.
ort upload-result-to-sw360
ORT 결과를 SW360에 업로드합니다.
입력 옵션
- -i, --ort-file=<값>: 입력으로 읽을 ORT 결과 파일입니다.
옵션
- -a, --attach-sources: 패키지 소스를 다운로드하여 SW360 릴리스에 첨부 파일로 업로드합니다.
- -h, --help: 이 메시지를 표시하고 종료합니다.