Configuração

Max PrilutskiyCEO e cofundadorAtualizado em: há 2 meses · 3 min de leitura

Obsoleto

Esta documentação cobre o CLI legado (v0). O CLI atual é o v1. Veja a documentação atual da CLI

Instale a CLI da Lingo.dev, configure seu projeto e gere suas primeiras traduções.

Pré-requisitos

Node.js 18 ou superior é obrigatório. Execute node -v para verificar sua versão.

Etapa 1. Inicialize um projeto#

1

Acesse seu projeto

bash
cd your-project-directory
2

Execute o comando init

bash
npx lingo.dev@latest init

Usuários do Windows: se npx lingo.dev não funcionar, instale primeiro o pacote com npm install lingo.dev@latest e use npx lingo no lugar.

Siga os prompts. A CLI cria um arquivo de configuração i18n.json na raiz do projeto.

Etapa 2. Configure um bucket#

No i18n.json, configure pelo menos um bucket — um formato de arquivo combinado com padrões de inclusão que indicam à CLI onde está o conteúdo traduzível:

json
{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.15",
  "locale": {
    "source": "en",
    "targets": ["es", "fr", "de"]
  },
  "buckets": {
    "json": {
      "include": ["locales/[locale].json"]
    }
  }
}

O placeholder [locale] é resolvido para os códigos de idioma configurados em tempo de execução — locales/en.json para a origem, locales/es.json para espanhol e assim por diante.

Para ver a lista completa de formatos de arquivo compatíveis e suas configurações de bucket, consulte Formatos compatíveis.

Etapa 3. Conecte um backend de tradução#

A CLI precisa de um backend de tradução para gerar as traduções. Há duas opções:

No Lingo.dev, um engine de localização aplica automaticamente voz da marca, glossário, regras e configuração do modelo a cada solicitação de tradução.

  1. Crie uma conta e gere uma chave de API na página API Keys.

  2. Defina a chave de API como uma variável de ambiente:

bash
export LINGO_API_KEY="your-api-key"

Nenhuma configuração adicional é necessária — a CLI usa o engine de localização padrão da sua organização. Para direcionar as traduções para um engine específico, adicione engineId ao seu i18n.json:

json
{
  "engineId": "eng_SxjMwMsfOIsvV1wh"
}

Etapa 4. Gere traduções#

bash
npx lingo.dev@latest run

A CLI encontra seus arquivos de origem, extrai o conteúdo traduzível, envia esse conteúdo ao backend de tradução configurado e grava os resultados de volta em disco. Um arquivo i18n.lock é criado para rastrear o que já foi traduzido — faça commit dele junto com seus arquivos de idioma.

Próximos passos#