{"id":62855,"date":"2024-04-09T17:36:04","date_gmt":"2024-04-09T14:06:04","guid":{"rendered":"https:\/\/nabfollower.com\/blog\/phrase-cli-config-yaml-3pdh\/"},"modified":"2024-04-09T17:36:04","modified_gmt":"2024-04-09T14:06:04","slug":"phrase-cli-config-yaml-3pdh","status":"publish","type":"post","link":"https:\/\/nabfollower.com\/blog\/phrase-cli-config-yaml-3pdh\/","title":{"rendered":"\u0639\u0628\u0627\u0631\u062a CLI Config YAML – DEV Community"},"content":{"rendered":"
\n

\u0627\u06cc\u0646\u062c\u0627\u0633\u062a .phrase.yml<\/code> \u0641\u0627\u06cc\u0644 \u0628\u0627 \u062a\u0645\u0627\u0645 \u0645\u0634\u062e\u0635\u0627\u062a \u0645\u0645\u06a9\u0646<\/p>\n

\u067e\u06cc\u062f\u0627 \u06a9\u0631\u062f\u0646 \u0622\u0646 \u062f\u0631 \u0648\u0628 \u0633\u0627\u06cc\u062a \u0631\u0627\u0647\u0646\u0645\u0627 Phrase \u0628\u0647 \u0637\u0631\u0632 \u0639\u062c\u06cc\u0628\u06cc \u062f\u0634\u0648\u0627\u0631 \u0627\u0633\u062a.<\/p>\n

\n
phrase<\/span>:<\/span>\n  access_token<\/span>:<\/span> ACCESS_TOKEN<\/span> #Add your personal access token to authenticate, you can find the steps on how to create one here: https:\/\/help.phrase.com\/help\/access-tokens<\/span>\n  project_id<\/span>:<\/span> PROJECT_ID<\/span> #The public Project ID which can be found in the Project Settings (API tab)<\/span>\n  file_format<\/span>:<\/span> FORMAT_API_EXTENSION<\/span> #Find the format you want to use here: https:\/\/help.phrase.com\/help\/supported-platforms-and-formats , access the article and copi the API extension<\/span>\n\n  push<\/span>:<\/span>\n    sources<\/span>:<\/span>\n    -<\/span> file<\/span>:<\/span> .\/path\/to\/file\/file.format<\/span> #Provide the path to the file(s) you want to push here, starting from the location of the configuration file. You can use the placeholders <locale_name>, <locale_code> and <tags> in the path or file-name<\/span>\n      params<\/span>:<\/span>\n        file_format<\/span>:<\/span> FORMAT_API_EXTENSION (string)<\/span> #See above. Only required if you deviate from the default format set in the header<\/span>\n        locale_id<\/span>:<\/span> LOCALE_ID (string)<\/span> #Can be the name (e.g. en-US) or public id (via Language settings -> API) of the locale. Preferred is the public id.<\/span>\n        tags<\/span>:<\/span> TAG_1, TAG_2 (string)<\/span> #List of tags separated by comma to be associated with the new keys contained in the upload.<\/span>\n        update_translations<\/span>:<\/span> false<\/span> (boolean)<\/span> #Indicates whether existing translations should be updated with the file content.<\/span>\n        update_descriptions<\/span>:<\/span> false<\/span> (boolean)<\/span> #Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions.<\/span>\n        skip_upload_tags<\/span>:<\/span> false<\/span> (boolean)<\/span> #Indicates whether the upload should not create upload tags.<\/span>\n        skip_unverification<\/span>:<\/span> false<\/span> (boolean)<\/span> #Indicates whether the upload should unverify updated translations.<\/span>\n        file_encoding<\/span>:<\/span> ENCODING (string)<\/span> #Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\", \"UTF-16BE\", \"UTF-16LE\" and \"ISO-8859-1\".<\/span>\n        locale_mapping<\/span>:<\/span> {<\/span>\"<\/span>LANGUAGE_CODE\"<\/span>:<\/span> \"<\/span>COLUMN\"<\/span>}<\/span> (object)<\/span> #Optional, format specific (Excel, CSV) mapping between locale names and the columns the translations to those locales are contained in.<\/span>\n        autotranslate<\/span>:<\/span> false<\/span> (boolean)<\/span> #If set, translations for the uploaded language will be fetched automatically.  <\/span>\n        mark_reviewed<\/span>:<\/span> false<\/span> (boolean)<\/span> #Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow (currently beta) is enabled for the project.<\/span>\n        #-------------<\/span>\n        format_options<\/span>:<\/span>\n          ignore_source_translations<\/span>:<\/span> false<\/span> (boolean)<\/span> #XLIFF\/XLIFF 2.0 only. Ignores the source translations in the file during the upload (to avoid accidental source language updates)<\/span>\n          ignore_target_translations<\/span>:<\/span> false<\/span> (boolean)<\/span> #XLIFF\/XLIFF 2.0 only. Ignores the target translations in the file during the upload (to avoid accidental target language updates)<\/span>\n          msgid_as_default<\/span>:<\/span> false<\/span> (boolean)<\/span> #Gettext template POT files. Use the key name (msgid) as translation (key names equal source translation in that format)<\/span>\n          strip_placeholder_delimiters<\/span>:<\/span> false<\/span> (boolean)<\/span> #XLIFF only. Removes <ph> tags from translations<\/span>\n          override_file_language<\/span>:<\/span> false<\/span> (boolean)<\/span> #XLIFF\/XLIFF 2.0 only. This file format typically contains language information in the file itself. Use this option to override the language with one you specify.<\/span>\n          key_index<\/span>:<\/span> [<\/span>empty<\/span>]<\/span>(integer)<\/span> #Excel\/CSV only. Index of the column containing the key names. Column indexes start at 1.<\/span>\n          comment_index<\/span>:<\/span> [<\/span>empty<\/span>]<\/span>(integer)<\/span> #Excel\/CSV only. Index of the column containing description for the key. Column indexes start at 1.<\/span>\n          tag_column<\/span>:<\/span> [<\/span>empty<\/span>]<\/span>(integer)<\/span> #Excel\/CSV only. Index of the column containing a tag for the key. Column indexes start at 1 .<\/span>\n          column_separator<\/span>:<\/span> ,<\/span> (string)<\/span> #CSV only. Char that is used to separate columns.<\/span>\n          quote_char<\/span>:<\/span> '<\/span>\"'<\/span> (string)<\/span> #CSV only. Char that is used to quote newlines and column separator.<\/span>\n          header_content_row<\/span>:<\/span> false<\/span> (boolean)<\/span> #CSV only. Indicates whether the first row contains only header information and should be skipped.<\/span>\n          first_content_row<\/span>:<\/span> 1 (integer)<\/span> #Excel only. Index of first row to contain translation content.<\/span>\n          enable_pluralization<\/span>:<\/span> true<\/span> (boolean)<\/span> #Simple\/Nested JSON only. Enables detection of pluralized keys. All matching keys will be persisted as pluralized keys.<\/span>\n          unescape_linebreaks<\/span>:<\/span> false<\/span> (boolean)<\/span> #Android XML only. All \\n will be imported as true newlines<\/span>\n          escape_single_quotes<\/span>:<\/span> false<\/span> (boolean)<\/span> #Java Properties only. Escape single quotes with another single quote (e.g. I'm -> I''m ).<\/span>\n\n  pull<\/span>:<\/span>\n    targets<\/span>:<\/span>\n    -<\/span> file<\/span>:<\/span> .\/path\/to\/file\/file.format<\/span>\n      params<\/span>:<\/span>\n        file_format<\/span>:<\/span> FORMAT_API_EXTENSION (string)<\/span> #See above. Only required if you deviate from the default format set in the header<\/span>\n        locale_id<\/span>:<\/span> LOCALE_ID (string)<\/span> #Can be the name (e.g. en-US) or public id (via Language settings -> API) of the locale. Preferred is the public id.<\/span>\n        tags<\/span>:<\/span> TAG_1, TAG_2 (string)<\/span> #Limit results to keys tagged with a list of comma separated tag names.<\/span>\n        include_empty_translations<\/span>:<\/span> false<\/span> (boolean)<\/span> #Indicates whether keys without translations should be included in the output as well.<\/span>\n        exclude_empty_zero_forms<\/span>:<\/span> false<\/span> (boolean)<\/span> #Indicates whether zero forms should be included when empty in pluralized keys.<\/span>\n        include_translated_keys<\/span>:<\/span> true<\/span> (boolean)<\/span> #Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.<\/span>\n        keep_notranslate_tags<\/span>:<\/span> false<\/span> (boolean)<\/span> #Indicates whether [NOTRANSLATE] tags should be kept.<\/span>\n        encoding<\/span>:<\/span> ENCODING (string)<\/span> #Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\", \"UTF-16BE\", \"UTF-16LE\" and \"ISO-8859-1\".<\/span>\n        include_unverified_translations<\/span>:<\/span> true<\/span> (boolean)<\/span> #If set to false unverified translations are excluded<\/span>\n        use_last_reviewed_version<\/span>:<\/span> false<\/span> (boolean)<\/span> #If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project.<\/span>\n        fallback_locale_id<\/span>:<\/span> LOCALE_ID (string)<\/span> #Can be the name (e.g. en-US) or public id (via Language settings -> API) of the locale. Preferred is the public id.<\/span>\n        #-------------<\/span>\n        format_options<\/span>:<\/span>\n          document_id<\/span>:<\/span> DOCUMENT_ID (string)<\/span> #Takes the document ID of the existing HTML documents in your project the export should be based on.<\/span>\n          enclose_in_cdata<\/span>:<\/span> false<\/span> (boolean)<\/span> #XLIFF\/Symfony XLIFF\/Android XML only. Encloses translations containing html tags in CDATA<\/span>\n          include_translation_state<\/span>:<\/span> false<\/span> (boolean)<\/span> #XLIFF\/Symfony XLIFF only. Include state of translations in the target locale<\/span>\n          indent_size<\/span>:<\/span> 4 (integer)<\/span> #XLIFF\/Android XML only. Specifies number of indentation characters<\/span>\n          indent_style<\/span>:<\/span> space (string)<\/span> #XLIFF\/Android XML only.Specifies indentation character. Allowed values are space and tab<\/span>\n          export_key_id_as_resname<\/span>:<\/span> true<\/span>\/false (boolean)<\/span> #XLIFF only. Exports the Key ID as the \"resname\" attribute.<\/span>\n          export_key_name_hash_as_extradata<\/span>:<\/span> true<\/span>\/false (boolean)<\/span> #XLIFF only. Exports the Key Name hash as the \"extradata\" attribute.<\/span>\n          delimit_placeholders<\/span>:<\/span> false<\/span> (boolean)<\/span> #XLIFF only. Removes <ph> tags from translations<\/span>\n          convert_placeholder<\/span>:<\/span> false<\/span> (boolean)<\/span> #iOS\/Android XML only. Placeholder will be converted to match format specific requirements. Example: '$s' => '$@'<\/span>\n          include_pluralized_keys<\/span>:<\/span> false<\/span> (boolean)<\/span> #iOS only. Also include pluralized keys in the locale file.<\/span>\n          export_tags<\/span>:<\/span> false<\/span> (boolean)<\/span> #Excel\/CSV only. Exports tags along with keys and translations.<\/span>\n          export_max_characters_allowed<\/span>:<\/span> false<\/span> (boolean)<\/span> #Excel\/CSV only.Exports the key character limit along with keys and translations.<\/span>\n          escape_linebreaks<\/span>:<\/span> false<\/span> (boolean)<\/span> #Android XML only. All line breaks will be escaped as '\\n'<\/span>\n          escape_single_quotes<\/span>:<\/span> false<\/span> (boolean)<\/span> #Java\/Play Framework Properties only. Escape single quotes with another single quote (e.g. I'm -> I''m ).<\/span>\n          omit_separator_space<\/span>:<\/span> false<\/span> (boolean)<\/span> #Java Properties only. Skip the space before and after the separator sign (= ).<\/span>\n          crlf_line_terminators<\/span>:<\/span> false<\/span> (boolean)<\/span> #Java Properties only. Use CRLF (Windows) line terminator chars.<\/span>\n<\/code><\/pre>\n
\n
\n    \u0648\u0627\u0631\u062f \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u0634\u0648\u06cc\u062f<\/title>\n    \n<\/svg><\/p>\n
    \u0627\u0632 \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u062e\u0627\u0631\u062c \u0634\u0648\u06cc\u062f<\/title>\n    \n<\/svg><\/p>\n<\/div>\n<\/div>\n<\/div><\/div>\n","protected":false},"excerpt":{"rendered":"
\u0627\u06cc\u0646\u062c\u0627\u0633\u062a .phrase.yml \u0641\u0627\u06cc\u0644 \u0628\u0627 \u062a\u0645\u0627\u0645 \u0645\u0634\u062e\u0635\u0627\u062a \u0645\u0645\u06a9\u0646 \u067e\u06cc\u062f\u0627 \u06a9\u0631\u062f\u0646 \u0622\u0646 \u062f\u0631 \u0648\u0628 \u0633\u0627\u06cc\u062a \u0631\u0627\u0647\u0646\u0645\u0627 Phrase \u0628\u0647 \u0637\u0631\u0632 \u0639\u062c\u06cc\u0628\u06cc \u062f\u0634\u0648\u0627\u0631 \u0627\u0633\u062a. phrase: access_token: ACCESS_TOKEN #Add your personal access token to authenticate, you can find the steps on how to create one here: https:\/\/help.phrase.com\/help\/access-tokens project_id: PROJECT_ID #The public Project ID which can be found in the Project …<\/p>\n","protected":false},"author":2,"featured_media":62856,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"fifu_image_url":"","fifu_image_alt":"","footnotes":""},"categories":[339],"tags":[],"class_list":["post-62855","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-dev"],"_links":{"self":[{"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/posts\/62855","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/comments?post=62855"}],"version-history":[{"count":0,"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/posts\/62855\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/media\/62856"}],"wp:attachment":[{"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/media?parent=62855"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/categories?post=62855"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/nabfollower.com\/blog\/wp-json\/wp\/v2\/tags?post=62855"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}