본문 바로가기
WIKI 기술 지식 베이스

Config 모듈

원문 보기 위키 갱신

The config module (@backstage/cli-module-config)은 Backstage 구성 스키마와 해석된 값을 검사, 출력, 검증하기 위한 명령을 제공합니다.

출처: 문서

본문

The config module (@backstage/cli-module-config)은 Backstage 구성 스키마와 해석된 값을 검사, 출력, 검증하기 위한 명령을 제공합니다.

config:docs

브라우저에서 앱의 로컬 구성 스키마에 대한 참조 문서를 엽니다. 어떤 구성 값이 사용 가능한지, 무엇을 하는지, 어디로 전송되는지 보는 데 사용하세요.

Usage: backstage-cli config:docs [options]Browse the configuration reference documentationOptions:  --package <name>  Only include the schema that applies to the given package  -h, --help        display help for command

config:print

정적 구성을 출력합니다. 기본적으로 저장소 루트의 app-config.yaml을 읽고, 저장소의 모든 로컬 패키지에서 수집한 스키마를 사용합니다.

예를 들어 주어진 구성 값이 my-app 패키지를 빌드할 때 프런트엔드에서 보이는지 검증하려면 다음을 사용할 수 있습니다.

yarn backstage-cli config:print --frontend --package my-app
Usage: backstage-cli config:print [options]Options:  --package <name>   Only load config schema that applies to the given package  --lax              Do not require environment variables to be set  --frontend         Print only the frontend configuration  --with-secrets     Include secrets in the printed configuration  --format <format>  Format to print the configuration in, either json or yaml [yaml]  --config <path>    Config files to load instead of app-config.yaml (default: [])  -h, --help         display help for command

config:check

정적 구성이 로드되고 스키마와 일치하는지 검증합니다. 기본적으로 저장소 루트의 app-config.yaml을 읽고 저장소의 모든 로컬 패키지에서 수집한 스키마를 사용합니다.

Usage: backstage-cli config:check [options]Options:  --package <name>  Only load config schema that applies to the given package  --lax             Do not require environment variables to be set  --frontend        Only validate the frontend configuration  --deprecated      Output deprecated configuration settings  --strict          Ensure that the provided config(s) has no errors and does not contain keys not in the schema.  --config <path>   Config files to load instead of app-config.yaml (default: [])  -h, --help        display help for command

config:schema

저장소의 모든 로컬 패키지에서 수집한 구성 스키마를 출력합니다.

note

yarn으로 실행할 때 명령줄 파이프에서 출력을 사용한다면 파이프라인에 스키마가 아닌 출력이 섞이지 않도록 yarn 옵션 --silent를 제공하세요.

Usage: backstage-cli config:schema [options]Print configuration schemaOptions:  --package <name>   Only output config schema that applies to the given package  --format <format>  Format to print the schema in, either json or yaml [yaml]  -h, --help         display help for command

더 알아보기 (Learn more)