Cliente de console (CLI)

Crowdin CLI é uma ferramenta de linha de comando que permite a você gerenciar e sincronizar os recursos de localização com o seu Crowdin projeto:

• Automatize o processo de atualização de seus arquivos de origem em seu projeto no Crowdin
• Baixe traduções do Crowdin e automaticamente salve-as nos locais corretos
• Carregar todas as suas traduções existentes para Crowdin em minutos
• Integre o Crowdin ao GIT, SVN, Mercurial e muito mais.

Esta é uma ferramenta multiplataforma executável num terminal nos sistemas operacionais Linux e MacOS ou no Prompt de Comando no Windows. Também é de código aberto e seu código-fonte está disponível no GitHub.

Requisitos

Verifique se você tem o Java 8 ou mais recente instalado. Digite java -version comando no terminal (Prompt de comando no Windows) para verificar a versão do Java. Por exemplo, versão do java “1.8.0_212” significa que você tem o Java 8 Update 212 instalado.

Se você não tem o Java instalado, baixe-o no site da Oracle.

Instalação

Homebrew para macOS

Para instalar o CLI Crowdin com homebrew (o gerenciador de pacotes para macOS):

$ brew tap crowdin/crowdin

$ brew install crowdin@3

Windows

Baixe e execute o instalador para Windows.

Debian

Nós assinamos todos os nossos pacotes com a Crowin Signing Key.

Baixe e instale a chave de assinatura pública:

wget -qO - https://artifacts.crowdin.com/repo/GPG-KEY-crowdin | sudo apt-key add -

Usando o comando a seguir, crie o arquivo crowdin.list no diretório /etc/apt/sources.list.d:

echo "deb https://artifacts.crowdin.com/repo/deb/ /" > /etc/apt/sources.list.d/crowdin.list

E o seu repositório está pronto para uso. Você pode instalar o pacote Crowdin CLI Debian com:

sudo apt-get update && sudo apt-get install crowdin3

Para instalar o Crowdin CLI manualmente:

$ wget https://artifacts.crowdin.com/repo/deb/crowdin3.deb -O crowdin.deb $ sudo dpkg -i crowdin.deb

RPM

Nós assinamos todos os nossos pacotes com a Crowin Signing Key.

Baixe e instale a chave de assinatura pública:

rpm --import https://artifacts.crowdin.com/repo/GPG-KEY-crowdin

Instalando a partir do repositório RPM

Crie um arquivo chamado crowdin.repo no diretório /etc//yum.repos.d contendo:

[crowdin] name=Crowdin repository baseurl=https://artifacts.crowdin.com/repo/rpm gpgcheck=1 gpgkey=https://artifacts.crowdin.com/repo/GPG-KEY-crowdin enabled=1

E o seu repositório está pronto para uso. Agora você pode instalar o Crowdin CLI com um dos seguintes comandos:

sudo yum install crowdin3 sudo dnf install crowdin3

Para instalar o Crowdin CLI manualmente:

$ wget https://artifacts.crowdin.com/repo/rpm/crowdin3.rpm -O crowdin.rpm $ sudo rpm -U crowdin3.rpm

Arch Linux

Visite a página do pacote do Crowdin CLI {:target=”_blank”} no repositório do usuário do Arch Linux.

NPM

Instalando a partir do repositório NPM

npm i -g @crowdin/cli

Versão autônoma

O Crowdin CLI pode ser instalado como um aplicativo Java independente.

Instalação no Linux e no macOS

1. Baixe crowdin-cli.zip usando o botão acima
2. Descompacte-o
3. Execute ./install-crowdin-cli.sh no terminal com direitos de sudo, a fim de adicionar o comando crowdin ao seu terminal

Instalação no Windows

1. Baixe crowdin-cli.zip usando o botão acima
2. Extraia seu conteúdo para o local onde você deseja que o Crowdin CLI seja armazenado
3. Abra o Prompt de Comando como Administrador
1. Clique em Iniciar
2. No tipo da Caixa de iniciar pesquisa, cmd, e depois pressioneCtrl+Shift+Enter
3. Se a caixa de diálogo Controlo de Conta de Utilizador (User Account Control), aparecer, confirma que a ação exibida é a desejada e, em seguida, clica em Continuar
4. Execute o script setup-crowdin.bat a fim de adicionar o comando crowdin ao Prompt de Comando
5. Reinicie seu Prompt de Comando

Usando Crowdin CLI com servidor proxy

Crowdin CLI oferece a possibilidade de trabalhar com um servidor proxy. Cada vez que você executa um comando, Crowdin CLI verifica se o sistema operacional tem as variáveis de ambiente configuradas.

Variáveis de ambiente com suporte:

HTTP_PROXY_HOST – o nome ou endereço IP do host em que o servidor proxy está localizado HTTP_PROXY_PORT – a porta usada pelo servidor proxy para escutar HTTP_PROXY_USER – o nome de usuário usado para autenticação em um servidor proxy HTTP_PROXY_PASSWORD – a senha usada para autenticação em um servidor proxy

Executando o aplicativo

Use o seguinte método para executar o aplicativo:

$ crowdin

Método alternativo:

$ java -jar crowdin-cli.jar

Configuração

Para usar o Crowdin CLI, você precisa ter um arquivo de configuração. Recomendamos nomear crowdin.yml. Você pode criá-lo executando o comando:

$ crowdin init

Ao chamar Crowdin CLI no terminal, você deve estar no diretório raiz do seu projeto. Caso contrário, você terá que especificar um caminho do arquivo de configuração usando a opção --config:

$ crowdin upload sources --config /caminho/para/seu/arquivo/de/configuração

Execute crowdin help para obter mais detalhes sobre outros comandos.

Exemplo de arquivo de configuração:

"project_id": "projectId"                     #abra as configurações do projeto e vá para a seção API 
"api_token": "personal-access-token"          #abra as configurações do perfil e vá para a API & SSO > Novo Token > criar Token
"base_path": "."                              #caminho para o diretório do seu projeto em uma máquina local
"base_url": "https://crowdin.com"
"preserve_hierarchy": true

"files": [
  {
      "source": "/en/**/*.json",                                          #filtro de arquivos originais
      "translation": "/%two_letters_code%/**/%original_file_name%"        #onde as traduções são armazenadas
  }
]

Para obter mais informações sobre como configurar a CLI Crowdin, leia o artigo Arquivo de configuração.

Uso

Depois que o arquivo de configuração é criado, você está pronto para começar a usar o Crowdin CLI para gerenciar seus recursos de localização e automatizar a sincronização de arquivos.

Comandos gerais

To show help information about Crowdin CLI:

$ crowdin help

Para gerar um esqueleto do arquivo de configuração:

$ crowdin init

Para verificar o arquivo de configuração por erros gerais:

$ crowdin lint

Para exibir uma lista de arquivos enviados para o Crowdin:

$ crowdin list project

Enviando recursos

Para fazer upload de arquivos fonte para o Crowdin:

$ crowdin upload sources

Para especificar os idiomas-alvo para os quais os arquivos originais não devem ser traduzidos:

$ crowdin upload sources --excluded-language uk fr

Para fazer upload de um único arquivo sem configuração:

$ crowdin upload sources -s "..." -t "..." -T personal-token -i project-id

Use marcadores para colocar variáveis adequadas.

Para exibir uma lista dos arquivos que serão enviados para o Crowdin:

$ crowdin upload sources --dryrun

Para enviar as traduções existentes para Crowdin (as traduções serão sincronizadas):

$ crowdin upload translations

Para mostrar informações detalhadas sobre o comando upload:

$ crowdin upload --help

Para adicionar rótulos existentes ou novos textos de origem:

$ crowdin upload sources -s "..." -t "..." --label "main-menu" --label "application"

Leia mais sobre rótulos.

Baixando fontes

Para baixar os arquivos de origem do Crowdin:

$ crowdin download sources

Baixar traduções

Para baixar as últimas traduções de Crowdin:

$ crowdin download

Para baixar as traduções mais recentes para o idioma específico (códigos de idioma):

$ crowdin download -l {language_code}

Para exibir uma lista das traduções mais recentes do Crowdin:

$ crowdin download --dryrun

Para mostrar uma informação detalhada sobre o comando download:

$ crowdin download --help

Baixando traduções para um arquivo de destino

Regardless of the initial source file format, there is a possibility to download translation files in the Android XML, iOS Strings, and XLIFF formats.

It’s beneficial when localizing mobile app content or when the final translation file format differs from the initial source format. You can use beforehand generated source files or send strings to your Crowdin project directly from design tools. When translations are finished, you can download them in the needed format and easily integrate them into the codebase.

To launch custom exporters and download files in the necessary format:

$ crowdin download targets <name>

Configuração

Adicione a seção alvos para seu arquivo de configuração crowdin.yml com a seguinte estrutura:

targets: [
  {
    name: "android",
    files: [
      {
        file: "targets/%two_letters_code%/android.xml",
        sources: [
            "file.xlsx"
        ],
        labels: [
            "mobile",
            "ui"
        ]
      }
    ]
  }
]

• name - o nome do seu alvo. Será usado para baixar destinos específicos.
• files - a seção que descreve os arquivos resultantes que aparecem em seu sistema após o download. Cada destino suporta o download de vários arquivos.
• file - o padrão de arquivo resultante. Currently supported file formats are the following: Android XML (.xml), iOS Strings (.strings), and XLIFF. Novos formatos de arquivo virão em breve.
• sources - os arquivos de origem no Crowdin, cujas traduções devem ser exportadas. Como alternativa, você pode especificar branches ou directories.
• labels - Rótulos para a filtragem de textos (opcional).

Como resultado, as traduções file.xlsx (filtradas por rótulos mobile e iu) serão baixadas para o arquivo targets/%two_letters_code%/android.xml.

Baixando Pseudo-localização

Existe a possibilidade de configurar e baixar arquivos de tradução pseudo-localizados.

Para baixar um arquivo com arquivos de tradução pseudo-localizados:

$ crowdin download --pseudo

Configuração

Adicione a seção pseudo_localization para seu arquivo de configuração crowdin.yml com a seguinte estrutura:

pseudo_localization: {
  length_correction: 25,
  prefix: "",
  suffix: "",
  character_transformation: "cyrillic"
}

Leia mais sobre Pseudo-localização.

Gerenciamento de versões

Não há necessidade de executar um comando específico para criar ramificações de versão se a CLI for usada. A ramificação da versão será criada automaticamente durante o upload dos arquivos.

Para enviar arquivos fonte para a versão específica:

$ crowdin upload sources -b {branch_name}

Para enviar traduções para a versão específica:

$ crowdin upload translations -b {branch_name}

Para baixar traduções para a versão específica:

$ crowdin download -b {branch_name}

Gerenciamento de textos de fonte

Existe a possibilidade de gerenciar (adicionar, editar, excluir) textos de caracteres de origem para os seguintes tipos de arquivo: CSV, RESX, JSON, XML do Android, textos de iOS, PROPERTIES.

Para mostrar uma lista de strings de origem no projeto atual (use a opção --verbose para ver mais informações):

$ crowdin string list

Para criar uma novo texto de origem (use a opção -h para ver todas as opções de comando possíveis):

$ crowdin string add

Para excluir o texto de origem:

$ crowdin string delete

Para editar o texto de origem existente:

$ crowdin string edit

Progresso de tradução e de revisão

Você pode verificar o progresso da tradução e da revisão de um projeto usando os seguintes comandos.

Para mostrar o progresso da tradução e da revisão de um projeto:

$ crowdin status

Para mostrar o progresso da tradução de um projeto:

$ crowdin status translation

Para mostrar o progresso da revisão de um projeto:

$ crowdin status proofreading

Além disso, você pode usar a oção --verbose para ver mais informações.

Gerenciamento de glossário

Existe a possibilidade de carregar e download de glossários.

Para mostrar uma lista de glossários (use a opção --verbose para mostrar listas de termos para glossários):

$ crowdin glossary list

Para fazer upload do glossário de um arquivo (em formato de arquivo TBX) para o glossário especificado ou para um novo:

$ crowdin glossary upload

Para fazer upload do glossário de um arquivo (em formato de arquivo CSV ou XLS/XLSX) para o glossário especificado ou para um novo:

$ crowdin glossary upload <file> --scheme term_en=0 --scheme description_en=1 --scheme partOfSpeech_en=2 --first-line-contains-header

Para formar o esquema de seu arquivo de glossário CSV ou XLS/XLSX, use as seguintes constantes:

term_{language_code} – A coluna contém os termos. {column_number} – Número da coluna. A numeração começa em 0. description_{language_code} – A coluna contém descrições de termos. partOfSpeech_{language_code} – A coluna contém classe gramatical para termos. where {language_code} – Código de idioma para o idioma especificado. Veja a lista completa de idiomas suportados. --first-line-contains-header – usado para pular a importação da primeira linha (cabeçalho).

Para baixar o glossário para um arquivo (no formato de arquivo TBX, CSV ou XLS/XLSX) do glossário especificado:

$ crowdin glossary download

Gerenciamento de memória de tradução

Existe a possibilidade de fazer upload e download de memórias de tradução.

Para mostrar uma lista de memórias de tradução:

$ crowdin tm list

Para carregar memória de tradução de um arquivo (em formato de arquivo TMX) para a memória de tradução especificada ou para uma nova:

$ crowdin tm upload

Para carregar memória de tradução de um arquivo (em formato de arquivo CSV ou XLS/XLSX) para a memória de tradução especificada ou para uma nova:

$ crowdin tm upload <file> --scheme en=0 --scheme fr=1 --first-line-contains-header

Para formar o esquema do arquivo de memória de tradução CSV ou XLS/XLSX, use as seguintes constantes:

{language_code} – A coluna contém elementos de memória de tradução para o idioma especificado. {column_number} – Número da coluna. A numeração começa em 0. where {language_code} – Código de idioma para o idioma especificado. Veja a lista completa de idiomas suportados. --first-line-contains-header – Usado para pular a importação da primeira linha (cabeçalho).

Para baixar a memória de tradução para um arquivo (em formato de arquivo TMX, CSV ou XLS/XLSX) da memória de tradução especificada:

$ crowdin tm download

Veja também

• Configuração do arquivo