CLI
    1. Phrase
    2. Phrase Strings
    3. CLI

    CLI 구성 파일 생성(Strings)

    컨텐츠는 영어 텍스트를 Phrase Language AI를 이용해 기계 번역한 것입니다.

    전제 조건

    • API 액세스 토큰 읽기 쓰기 범위와 함께

    • 프로젝트 설정의 API 탭에 표시된 Strings 프로젝트 ID

    • 들여쓰기를 포함한 기본 YAML 지식

    • CI에서 phrase push 또는 phrase pull을 실행할 경우 Git 읽기 및 쓰기 권한

    구성 파일을 자동으로 생성하려면 다음 단계를 수행하십시오:

    1. 명령줄에서 phrase init을 입력하여 .phrase.yml 파일을 생성합니다.

      구성 마법사가 CLI에서 시작됩니다.

    2. 다음을 제공합니다:

      • 액세스 토큰

        붙여넣거나 Enter를 눌러 $PHRASE_ACCESS_TOKEN을 사용하도록 합니다.

      • Strings 프로젝트 ID (예: abcdef1234567890abcdef1234567890)

      • 로캘 파일 형식 (예: json, rails_yaml, ios_strings)

      • 로컬 경로

        프로젝트 코드베이스의 로캘 파일에 대한 glob 또는 정확한 경로 (예: config/locales/*.json)

    기본 .phrase.yml 파일이 현재 디렉토리에 생성됩니다.

    팁

    마법사를 완전히 건너뛰기 위해 플래그를 제공하십시오. 예: phrase init --access_token=$PHRASE_ACCESS_TOKEN --project_id=... --file_format=ios_strings --path='ios/*.strings'.

    수동으로 생성 또는 복사된 구성 파일을 사용하는 경우 다음 중 하나의 위치에 놓습니다:

    • CLI 클라이언트가 호출되는 현재 작업 디렉터리(pwd)입니다.

    • 현재 사용자의 홈 디렉터리(Unix의 $HOME, Windows의 $HomePath)입니다.

    • PHRASEAPP_CONFIG 환경 변수에 지정된 경로입니다.

    • --config 플래그를 통한 구성 파일 경로(예: /some/path/to/phrase.yml)입니다.

    CLI 옵션 개요입니다.

    샘플 구성 파일입니다.

    전역 설정입니다. 

    키입니다.

    유형입니다.

    필수입니다.

    설명입니다.

    phrase.access_token 

    문자열입니다.

    예입니다.

    개인 액세스 토큰입니다.

    phrase.project_id 

    문자열입니다.

    예입니다.

    Strings 프로젝트 설정에 표시된 공개 프로젝트 ID입니다.

    phrase.file_format 

    문자열입니다.

    예입니다.

    기본 로캘 파일 형식 (API 확장)입니다.

    phrase.locale_mapping

    객체입니다.

    아니요입니다.

    Phrase 로캘 ID를 사용자 지정 이름에 매핑하여 <locale_name> 자리 표시자와 함께 파일 경로에서 사용합니다. 이것은 Android와 같은 비표준 명명 규칙을 가진 플랫폼에 유용합니다.

    매핑에 로캘이 지정되지 않은 경우, 기본적으로 표준 Phrase 로캘 이름이 사용됩니다.

    푸시: 소스

    키입니다.

    유형입니다.

    필수입니다.

    설명입니다.

    push.sources[].file 

    경로

    예입니다.

    푸시할 파일에 대한 상대 경로, 예: ./path/to/file/<locale_code>.json. <locale_name>, <locale_code>, <tags>를 지원합니다.

    push.sources[].project_id 

    문자열입니다.

    이 특정 파일 소스에 대해 전역 project_id를 재정의합니다. 같은 구성 파일에서 여러 Phrase 프로젝트에 파일을 푸시할 때 유용합니다. 

    푸시: 매개변수

    매개변수

    유형입니다.

    기본값

    설명입니다.

    file_format 

    문자열입니다.

    헤더

    이 소스에 대한 파일 형식을 재정의합니다.

    locale_id 

    문자열입니다.

    —

    로캘 이름(예: en-US) 또는 공개 로캘 ID.

    tags 

    문자열입니다.

    —

    새 키에 대한 쉼표로 구분된 태그.

    update_translations 

    부울

    false 

    파일 콘텐츠로 기존 번역을 업데이트합니다.

    update_translation_keys 

    부울

    true 

    여기 false를 전달하여 새 키가 생성되고 기존 키가 업데이트되는 것을 방지합니다.

    update_descriptions 

    부울

    false 

    키 설명을 업데이트합니다; 비어 있는 설명은 기존 설명을 덮어씁니다.

    skip_upload_tags 

    부울

    false 

    업로드 태그가 생성되지 않습니다.

    skip_unverification 

    부울

    false 

    업데이트된 번역은 확인되지 않습니다.

    file_encoding 

    문자열입니다.

    —

    파일 인코딩: UTF-8, UTF-16, UTF-16BE, UTF-16LE, 또는 ISO-8859-1.

    locale_mapping 

    객체입니다.

    —

    (Excel/CSV 전용) 로캘 코드를 열 이름에 매핑합니다, 예: {"en": "C", "de": "D"} 번역을 파싱하기 위해. 이는 파일 경로에 사용되는 최상위 로캘 매핑와 다릅니다.

    자동 번역 

    부울

    false 

    업로드된 언어에 대한 번역을 자동으로 가져옵니다.

    mark_reviewed 

    부울

    false 

    가져온 번역을 검토됨으로 표시합니다 (고급 검토 워크플로가 활성화되어야 합니다).

    푸시: 형식 옵션

    CLI 구성에서 모든 사용 가능한 형식 옵션이 지원됩니다. 예제를 보려면 샘플 구성 파일을 참조하십시오.

    풀: 대상

    키입니다.

    유형입니다.

    필수입니다.

    설명입니다.

    pull.targets[].file 

    경로

    예입니다.

    가져온 로캘 파일의 상대 경로, 예: ./Radio.de/<locale_code>.lproj/Localizable.strings.

    pull.targets[].project_id 

    문자열입니다.

    이 특정 풀 대상을 위해 전역 프로젝트 ID를 재정의합니다. 동일한 구성 파일을 사용하여 여러 Phrase 프로젝트에서 번역을 가져오는 것을 활성화합니다.

    가져오기: 매개변수

    매개변수

    유형입니다.

    기본값

    설명입니다.

    file_format 

    문자열입니다.

    —

    문자열이어야 합니다.

    locale_id 

    문자열입니다.

    —

    로캘 이름(예: en-US) 또는 공개 로캘 ID.

    tags 

    문자열입니다.

    —

    가져올 키를 필터링하기 위한 쉼표로 구분된 태그입니다.

    include_empty_translations 

    부울

    false 

    번역이 없는 키를 포함합니다.

    exclude_empty_zero_forms 

    부울

    false 

    비어 있을 때 제로형 복수형을 제외합니다.

    include_translated_keys 

    부울

    true 

    이미 번역이 있는 키를 포함합니다.

    keep_notranslate_tags 

    부울

    false 

    출력에서 [NOTRANSLATE] 태그를 보존합니다.

    인코딩 

    문자열입니다.

    —

    파일 인코딩: UTF-8, UTF-16, UTF-16BE, UTF-16LE, 또는 ISO-8859-1.

    include_unverified_translations 

    부울

    true 

    false인 경우, 확인되지 않은 번역을 제외합니다.

    use_last_reviewed_version 

    부울

    false 

    true인 경우, 마지막 검토된 버전을 사용합니다(고급 검토 워크플로가 필요합니다).

    fallback_locale_id 

    문자열입니다.

    —

    누락된 번역에 사용할 대체 로캘입니다.

    가져오기: 형식 옵션

    CLI 구성에서 모든 사용 가능한 형식 옵션이 지원됩니다. 예제를 보려면 샘플 구성 파일을 참조하십시오.

    다중 구성

    모노레포에서는 각 패키지에 하나의 구성 파일을 배치하고 해당 하위 폴더에서 CLI를 실행하거나 CI 작업을 --config 옵션으로 다른 구성 파일에 지정합니다.

    Git 통합

    GitLab:

    • .phrase.yml 구성 파일은 리포지토리에 있어야 합니다. 이 파일은 리포지토리로부터 가져오기(pull) 또는 내보내기(push)할 파일을 정의합니다.

    • 리포지토리에 대한 읽기 및 쓰기 액세스 권한이 필요합니다.

    • 잘못 정의된 구성 파일은 오류를 일으킬 수 있습니다. 파일에 하나 이상의 push 및 pull 대상이 있는지, 파일 형식이 올바른지, update_translations 매개 변수의 설정이 올바른지 확인하십시오.

    • GitLab 9.5 이상을 사용하면 API가 호환됩니다.

    GitHub:

    • .phrase.yml 구성 파일은 리포지토리에 있어야 합니다. 이 파일은 리포지토리로부터 가져오기(pull) 또는 내보내기(push)할 파일을 정의합니다.

    • 리포지토리에 대한 읽기 및 쓰기 액세스 권한이 필요합니다.

    • 잘못 정의된 구성 파일은 오류를 일으킬 수 있습니다. 파일에 하나 이상의 push 및 pull 대상이 있는지, 파일 형식이 올바른지, update_translations 매개 변수의 설정이 올바른지 확인하십시오.

    • 리포지토리의 범위에 대한 GitHub 액세스 토큰(공용 리포지토리와 동기화하는 경우 public_repo).

    • GitHub에서 SSO가 활성화된 경우 액세스 토큰에 대해서도 활성화해야 합니다.

    • phrase_translations 분기가 보호되지 않습니다.

    • 리포지토리 설정에 서명된 커밋이 필요하지 않은지 확인하십시오.

    BitBucket:

    • .phrase.yml 구성 파일은 리포지토리에 있어야 합니다. 이 파일은 리포지토리로부터 가져오기(pull) 또는 내보내기(push)할 파일을 정의합니다.

    • 리포지토리에 대한 읽기 및 쓰기 액세스 권한이 필요합니다.

    • 잘못 정의된 구성 파일은 오류를 일으킬 수 있습니다. 파일에 하나 이상의 push 및 pull 대상이 있는지, 파일 형식이 올바른지, update_translations 매개 변수의 설정이 올바른지 확인하십시오. 

    도움이 되었습니까?
    ★ ★ ★ ★ ★

    Sorry about that! In what way was it not helpful?

    The article didn’t address my problem.
    I couldn’t understand the article.
    The feature doesn’t do what I need.
    Other reason.

    Note that feedback is provided anonymously so we aren't able to reply to questions.
    If you'd like to ask a question, submit a request to our Support team.
    Thank you for your feedback.