CLI 명령 및 옵션 요약
사용법
snyk [COMMAND] [SUBCOMMAND] [OPTIONS] [PACKAGE] [CONTEXT-SPECIFIC-OPTIONS]
설명
Snyk CLI는 프로젝트에서 알려진 취약점을 찾아 해결하는 빌드 시간 도구입니다. 더 자세한 Snyk CLI 및 Snyk 설명은 Snyk CLI를 참조하세요. Snyk CLI 사용 방법에 대한 소개는 CLI로 시작하기에서 확인할 수 있습니다.
사용 가능한 CLI 명령
각 Snyk CLI 명령에 대한 자세한 정보는 --help
옵션을 사용하여 확인하십시오. 예를 들어, snyk auth --help
또는 snyk container --help
와 같이 사용합니다. 이 목록의 각 명령은 해당 문서에서 도움링크 페이지로 연결됩니다.
참고: Snyk CLI 명령에 대한 옵션 목록이 이 페이지에 있습니다. 각 명령에 대한 도움링크에서 옵션에 대한 자세한 내용이 설명되어 있습니다.
Snyk 계정으로 Snyk CLI를 인증합니다.
Snyk CLI 구성을 관리합니다.
--snyk auth
명령을 실행하기 전에 지역 환경을 설정하는 데 사용합니다.
오픈 소스 취약점 및 라이선스 문제를 위해 프로젝트를 테스트합니다.
프로젝트를 스냅샷으로 만들고 오픈 소스 취약점 및 라이선스 문제를 계속해서 모니터링합니다.
snyk code
명령의 이름을 확인합니다. 도움 옵션과 함께 사용하는 방법: snyk code test
소스 코드를 검사하여 알려진 보안 문제를 확인합니다(정적 응용 프로그램 보안 테스트).
snyk container
명령, snyk container monitor
, snyk container test
를 출력합니다.
컨테이너 이미지 계층과 종속성을 캡처하고 snyk.io에서 취약점을 모니터링합니다.
컨테이너 이미지에 대한 SBOM을 생성합니다.
컨테이너 이미지를 알려진 취약점으로 테스트합니다.
snyk iac
명령 목록을 출력합니다: snyk iac describe
, snyk iac update-exclude-policy
, snyk iac test
.
알려진 보안 문제를 확인합니다.
코드에서 Terraform 상태 파일로부터 리소스 매핑을 생성하는 데 필요한 최소한의 정보를 포함한 매핑 아티팩트를 생성하고 해당 매핑 아티팩트를 Snyk에 보냅니다.
인프라 드리프트와 관리되지 않는 리소스를 감지하고 추적 및 경고를 합니다.
사용자 정의 규칙 프로젝트 구조, 관계, 규칙 또는 사양을 초기화합니다.
모든 사용자 정의 규칙에 대한 테스트를 실행합니다.
사용자 정의 규칙 번들을 묶어서 Snyk 클라우드 API에 업로드합니다.
snyk iac describe
에서 사용할 제외 정책 규칙을 생성합니다.
지정된 문제를 무시하기 위해 .snyk
정책을 수정합니다.
Log4Shell 취약점을 찾습니다.
패키지에 대한 .snyk
정책을 표시합니다.
Snyk에서 지원하는 생태계 내 소프트웨어 프로젝트에 대한 SBOM을 생성합니다.
오픈 소스 패키지의 취약점을 확인하는 SBOM을 확인합니다.
Snyk CLI를 사용하여 Snyk 앱을 만듭니다. 자세한 내용은 Snyk 앱을 참조하세요.
CLI 명령의 하위 명령
다음은 Snyk CLI 명령의 하위 명령 목록입니다. 각 하위 명령 뒤에 해당되는 명령이 나옵니다. 명령어는 도움 문서로 연결됩니다. 각 하위 명령에 대한 자세한 정보는 해당 도움 문서를 참조하세요.
get <KEY>
: config
의 하위 명령
set <KEY>=<VALUE>
: config
의 하위 명령
unset <KEY>
: config
의 하위 명령
clear
: config
의 하위 명령
environment
: config
의 하위 명령
Snyk CLI 구성
환경 변수를 사용하여 Snyk CLI를 구성하고 Snyk CLI가 Snyk API에 연결할 수 있도록 변수를 설정할 수 있습니다. Snyk CLI 구성을 참조하세요.
디버깅
자세한 내용은 Snyk CLI 디버깅을 참조하세요.
CLI 명령의 종료 코드
test
명령에 대한 종료 코드는 모두 동일합니다. 다음 도움 문서에서 종료 코드를 확인하세요:
다음 도움 문서에 나열된 다른 CLI 명령에 대한 종료 코드가 있습니다:
여러 명령의 옵션
Snyk CLI 명령의 옵션 목록이 옵션에 적용되는 명령 뒤에 나옵니다. 명령은 해당 도움 문서로 연결됩니다. 각 옵션에 대한 자세한 정보는 도움 문서를 참조하세요.
--all-projects
: test
, monitor
, sbom
--detection-depth=<DEPTH>
: test
, monitor
, iac test
, sbom
--exclude=<NAME>[,<NAME>]...>
: test
, monitor
, sbom
--prune-repeated-subdependencies, -p
: test
, monitor
, sbom
--print-deps
: test
, monitor
, container test
--remote-repo-url=<URL>
: test
, monitor
, iac test
--org=<ORG_ID>
: test
, monitor
, code test
, container test
, container monitor, iac test
, iac describe
, iac capture
, sbom
, container sbom
--file=<FILE_PATH>
: container test, container monitor
, sbom test
--package-manager=<PACKAGE_MANAGER_NAME>
: test
, monitor
--unmanaged:
test,
monitor. 사용하지 않는 리소스에 대한 스캔 옵션 및 sbom
명령어 도움 링크에서 이 옵션을 또 사용하는 방법을 참조하세요.
--ignore-policy
: test
, monitor
, iac test
, iac describe
--trust-policies
test
, monitor
--show-vulnerable-paths=<none|some|all>
test
--project-name=<PROJECT_NAME>
: test
, monitor
, container test
, containernyk.io/snyk-cli/commands/monitor), [
iac test](https://docs.snyk.io/snyk-cli/commands/iac-test)
,[
container monitor`
--policy-path=<PATH_TO_POLICY_FILE>
: test
, monitor
, container test
, container monitor
, iac test
, iac describe
, ignore
--json
: test
, monitor
, code test
, container test
, container monitor
, iac test
, iac describe
, sbom test
--json-file-output=<OUTPUT_FILE_PATH>
: test
, code test
, container test
, iac test
,sbom
--sarif
: test
, code test
, container test
, iac test
--sarif-file-output=<OUTPUT_FILE_PATH>
: test
, code test
, container test
, iac test
--severity-threshold=<low|medium|high|critical>
: test
, code test
, container test
, iac test
--fail-on=<all|upgradable|patchable>
: container test
, test
--project-environment=<ENVIRONMENT>[,<ENVIRONMENT>]...
: monitor
, container monitor
, iac test
--project-lifecycle=<LIFECYCLE>[,<LIFECYCLE>]...
: monitor
, container monitor
, iac test
--project-business-criticality=<BUSINESS_CRITICALITY>[,<BUSINESS_CRITICALITY>]...
: monitor
, container monitor
, iac test
--project-tags=<TAG>[,<TAG>]...
: monitor
, container monitor
, iac test
--tags=<TAG>[,<TAG>]...
: monitor
, container monitor
snyk auth
커맨드 옵션
snyk auth
커맨드 옵션--auth-type=<TYPE>
--client-secret=<SECRET>
--client-id=<ID>
snyk auth
snyk code test
커맨드 옵션
snyk code test
커맨드 옵션--include-ignores
: code test
snyk config environment
커맨드 옵션
snyk config environment
커맨드 옵션--no-check
snyk config environment
snyk container
커맨드 옵션
snyk container
커맨드 옵션--app-vulns
: container test
, container monitor
--exclude-app-vulns
: container test
, container monitor
, container sbom
--nested-jars-depth
: container test
, container monitor
--exclude-base-image-vulns
: container test
, container monitor
--platform=<PLATFORM>
: container test
, container monitor
--username=<CONTAINER_REGISTRY_USERNAME>
: container test
, container monitor
--password=<CONTAINER_REGISTRY_PASSWORD>
: container test
, container monitor
snyk iac test
커맨드 옵션
snyk iac test
커맨드 옵션--scan=<TERRAFORM_PLAN_SCAN_MODE>
: iac test
--target-name=<TARGET_NAME>
: iac test
--rules=<PATH_TO_CUSTOM_RULES_BUNDLE>
: iac test
--var-file=<PATH_TO_VARIABLE_FILE>
: iac test
--report
: iac test
snyk iac capture
커맨드 옵션
snyk iac capture
커맨드 옵션--stdin
: iac capture
PATH
: iac capture
snyk iac describe
커맨드 옵션
snyk iac describe
커맨드 옵션--from=<STATE>[,<STATE>...]
: iac describe
--to=<PROVIDER+TYPE>
: iac describe
--service=<SERVICE>[,<SERVICE]...>
: iac describe
--quiet
: iac describe
--filter
: iac describe
--html
: iac describe
--html-file-output=<OUTPUT
FILE
PATH>
: iac-describe
--fetch-tfstate-headers
: iac describe
--tfc-token
: iac describe
--tfc-endpoint
: iac describe
--tf-provider-version
: iac describe
--strict
: iac describe
--deep
: iac describe
--tf-lockfile
: iac describe
--config-dir
: iac describe
snyk iac update-exclude-policy
커맨드 옵션
snyk iac update-exclude-policy
커맨드 옵션--exclude-changed
: iac update-exclude-policy
--exclude-missing
: iac update-exclude-policy
--exclude-unmanaged
: iac update-exclude-policy
snyk iac rules push
커맨드 옵션
snyk iac rules push
커맨드 옵션--delete
: iac rules push
snyk iac rules test
커맨드 옵션
snyk iac rules test
커맨드 옵션--update-expected
: iac rules test
snyk ignore
커맨드 옵션
snyk ignore
커맨드 옵션--id=<ISSUE_ID>
: ignore
--expiry=<EXPIRY>
: ignore
--reason=<REASON>
: ignore
--path=<PATH_TO_RESOURCE>
: ignore
snyk sbom
및 snyk container sbom
커맨드 옵션
snyk sbom
및 snyk container sbom
커맨드 옵션--format=<cyclonedx1.4+json|cyclonedx1.4+xml|cyclonedx1.5+json|cyclonedx1.5+xml|cyclonedx1.6+json|cyclonedx1.6+xml|spdx2.3+json>
: snyk sbom
, snyk container sbom
[--file=] or [--f=]
: snyk sbom
[--name=<NAME>]
: snyk sbom
[--version=<VERSION>]
: snyk sbom
[<TARGET_DIRECTORY>]
: snyk sbom
<IMAGE>
: snyk container sbom
메이븐 프로젝트를 위한 옵션
--maven-aggregate-project
: test
, monitor
--scan-unmanaged
: test
, monitor
--scan-all-unmanaged
: test
, monitor
그레들 프로젝트를 위한 옵션
--sub-project=<NAME>
, --gradle-sub-project=<NAME>
: test
, monitor
--all-sub-projects
: test
, monitor
--configuration-matching=<CONFIGURATION_REGEX>
: test
, monitor
--configuration-attributes=<ATTRIBUTE>[,<ATTRIBUTE>]...
: test
, monitor
--init-script=<FILE
: test
, monitor
.Net 및 NuGet 프로젝트를 위한 옵션
--file=.sln
: test
--file=<filename>.sln
: sbom
--file=packages.config
: test, sbom
--assets-project-name
: test
, monitor
, sbom
--packages-folder
: test
, monitor
, sbom
--project-name-prefix=<PREFIX_STRING>
: test
, monitor
--project-name-prefix=my-group/
: test
, monitor
--dotnet-runtime-resolution
: test,
monitor
--dotnet-target-framework
: test,
monitor
Options for npm projects
--strict-out-of-sync=true|false
: test
, monitor
, sbom
Options for pnpm projects
--fail-on
: test
--prune-repeated-subdependencies
: test
, monitor
Options for Yarn projects
--strict-out-of-sync=true|false
: test
, monitor
, sbom
--yarn-workspaces
: test
, monitor
, sbom
Options for CocoaPods projects
--strict-out-of-sync=true|false
: test
, monitor
Options for Python projects
--command=<COMMAND>
: test
, monitor
, sbom
--skip-unresolved=true|false
: test
, monitor
, sbom
--File=<filename>:
sbom
--pakage-manager=<package manager>
: sbom
Options for Go projects
다음 옵션은 지원되지 않습니다:
--fail-on=<all|upgradable|patchable>
: test
Options for scanning using --unmanaged
--unmanaged
--json-file-output=<OUTPUT_FILE_PATH>
: test
--remote-repo-url=<URL>
: test
--severity-threshold=<low|medium|high|critical>:
test
--target-reference=<TARGET_REFERENCE>
: test
, monitor
--max-depth
: test
, monitor
, sbom
--print-dep-paths:
test
, monitor
--project-name=c-project
: monitor
-- [<CONTEXT-SPECIFIC_OPTIONS>]
-- [<CONTEXT-SPECIFIC_OPTIONS>]
이러한 옵션은 snyk test
및 snyk monitor
명령어와 함께 사용됩니다. 자세한 내용은 snyk test
및 snyk monitor
의 도움말을 참조하십시오.
Last updated