@intlayer/docs 7.2.3 → 7.3.0

package/docs/pt/cli/live.md

@@ -0,0 +1,41 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Comandos Live Sync
+description: Aprenda como usar o Live Sync para refletir mudanças de conteúdo do CMS em tempo de execução.
+keywords:
+  - Live Sync
+  - CMS
+  - Runtime
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - live
+---
+
+# Comandos Live Sync
+
+O Live Sync permite que seu app reflita mudanças de conteúdo do CMS em tempo de execução. Não é necessário rebuild ou redeploy. Quando ativado, as atualizações são transmitidas para um servidor Live Sync que atualiza os dicionários que sua aplicação lê. Veja [Intlayer CMS](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/intlayer_CMS.md) para mais detalhes.
+
+```json fileName="package.json"
+"scripts": {
+  "intlayer:live:start": "npx intlayer live start --with 'next dev --turbopack'"
+}
+```
+
+## Argumentos:
+
+**Opções de configuração:**
+
+- **`--base-dir`**: Especifica o diretório base do projeto. Para recuperar a configuração do intlayer, o comando irá procurar pelo arquivo `intlayer.config.{ts,js,json,cjs,mjs}` no diretório base.
+
+- **`--no-cache`**: Desativa o cache.
+
+  > Exemplo: `npx intlayer dictionary push --env-file .env.production.local`
+
+**Opções de log:**
+
+- **`--verbose`**: Ativa o log detalhado para depuração. (padrão é true ao usar CLI)

package/docs/pt/cli/pull.md

@@ -0,0 +1,78 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Puxar Dicionários
+description: Aprenda como puxar dicionários do editor Intlayer e CMS.
+keywords:
+  - Puxar
+  - Dicionários
+  - CLI
+  - Intlayer
+  - Editor
+  - CMS
+slugs:
+  - doc
+  - concept
+  - cli
+  - pull
+---
+
+# Puxar Dicionários Remotos
+
+```bash
+npx intlayer pull
+```
+
+Se o [editor intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/intlayer_visual_editor.md) estiver instalado, você também pode puxar dicionários a partir do editor. Dessa forma, você pode sobrescrever o conteúdo dos seus dicionários conforme a necessidade da sua aplicação.
+
+## Apelidos:
+
+- `npx intlayer dictionaries pull`
+- `npx intlayer dictionary pull`
+- `npx intlayer dic pull`
+
+## Argumentos:
+
+**Opções de Dicionário:**
+
+- **`-d, --dictionaries`**: IDs dos dicionários para puxar. Se não especificado, todos os dicionários serão puxados.
+
+  > Exemplo: `npx intlayer dictionary pull -d my-dictionary-id my-other-dictionary-id`
+
+- **`--dictionary`**: IDs dos dicionários para puxar (apelido para --dictionaries).
+
+  > Exemplo: `npx intlayer dictionary pull --dictionary my-dictionary-id my-other-dictionary-id`
+
+**Opções de configuração:**
+
+- **`--base-dir`**: Especifica o diretório base do projeto. Para recuperar a configuração do intlayer, o comando procurará o arquivo `intlayer.config.{ts,js,json,cjs,mjs}` no diretório base.
+
+  > Exemplo: `npx intlayer dictionary push --env-file .env.production.local`
+
+- **`--no-cache`**: Desabilita o cache.
+
+  > Exemplo: `npx intlayer build --no-cache`
+
+**Opções de variáveis de ambiente:**
+
+- **`--env`**: Especifica o ambiente (ex.: `development`, `production`).
+- **`--env-file`**: Fornece um arquivo de ambiente personalizado para carregar as variáveis.
+- **`--base-dir`**: Especifica o diretório base do projeto. Para recuperar a configuração do intlayer, o comando procurará o arquivo `intlayer.config.{ts,js,json,cjs,mjs}` no diretório base.
+
+  > Exemplo: `npx intlayer dictionary push --env-file .env.production.local`
+
+  > Exemplo: `npx intlayer dictionary push --env production`
+
+**Opções de saída:**
+
+- **`--new-dictionaries-path`**: Caminho para o diretório onde os novos dicionários serão salvos. Se não especificado, os novos dicionários serão salvos no diretório `./intlayer-dictionaries` do projeto. Se um campo `filePath` for especificado no conteúdo do seu dicionário, os dicionários não considerarão este argumento e serão salvos no diretório especificado pelo `filePath`.
+
+**Opções de log:**
+
+- **`--verbose`**: Ativa o log detalhado para depuração. (padrão para true ao usar CLI)
+
+## Exemplo:
+
+```bash
+npx intlayer dictionary pull --newDictionariesPath ./my-dictionaries-dir/
+```

package/docs/pt/cli/push.md

@@ -0,0 +1,98 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Enviar Dicionários
+description: Aprenda como enviar seus dicionários para o editor e CMS do Intlayer.
+keywords:
+  - Enviar
+  - Dicionários
+  - CLI
+  - Intlayer
+  - Editor
+  - CMS
+slugs:
+  - doc
+  - concept
+  - cli
+  - push
+---
+
+# Enviar Dicionários
+
+```bash
+npx intlayer dictionary push
+```
+
+Se o [editor Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/intlayer_visual_editor.md) estiver instalado, você também pode enviar dicionários para o editor. Este comando permitirá tornar os dicionários disponíveis para [o editor](https://intlayer.org/dashboard). Dessa forma, você pode compartilhar seus dicionários com sua equipe e editar seu conteúdo sem precisar alterar o código da sua aplicação.
+
+## Apelidos:
+
+- `npx intlayer dictionaries push`
+- `npx intlayer dictionary push`
+- `npx intlayer dic push`
+
+## Argumentos:
+
+**Opções de Dicionário:**
+
+- **`-d`, `--dictionaries`**: ids dos dicionários para enviar. Se não especificado, todos os dicionários serão enviados.
+
+  > Exemplo: `npx intlayer dictionary push -d my-dictionary-id my-other-dictionary-id`
+
+- **`--dictionary`**: ids dos dicionários para enviar (apelido para --dictionaries).
+
+  > Exemplo: `npx intlayer dictionary push --dictionary my-dictionary-id my-other-dictionary-id`
+
+**Opções de Configuração:**
+
+- **`--base-dir`**: Especifica o diretório base do projeto. Para recuperar a configuração do intlayer, o comando irá procurar pelo arquivo `intlayer.config.{ts,js,json,cjs,mjs}` no diretório base.
+
+  > Exemplo: `npx intlayer dictionary push --env-file .env.production.local`
+
+- **`--no-cache`**: Desativa o cache.
+
+  > Exemplo: `npx intlayer build --no-cache`
+
+**Opções de variáveis de ambiente:**
+
+- **`--env`**: Especifica o ambiente (ex.: `development`, `production`). Útil no caso de uso de variáveis de ambiente no arquivo de configuração do intlayer.
+- **`--env-file`**: Fornece um arquivo de ambiente personalizado para carregar as variáveis. Útil no caso de uso de variáveis de ambiente no arquivo de configuração do intlayer.
+
+  > Exemplo: `npx intlayer dictionary push --env-file .env.production.local`
+
+  > Exemplo: `npx intlayer dictionary push --env production`
+
+**Opções de saída:**
+
+- **`-r`, `--delete-locale-dictionary`**: Ignora a pergunta que solicita a exclusão dos diretórios de locais após o envio dos dicionários, e os remove. Por padrão, se o dicionário estiver definido localmente, ele sobrescreverá o conteúdo dos dicionários remotos.
+
+  > Exemplo: `npx intlayer dictionary push -r`
+
+  > Exemplo: `npx intlayer dictionary push --delete-locale-dictionary`
+
+- **`-k`, `--keep-locale-dictionary`**: Ignora a pergunta que solicita a exclusão dos diretórios de locais após o envio dos dicionários, e os mantém. Por padrão, se o dicionário estiver definido localmente, ele sobrescreverá o conteúdo dos dicionários remotos.
+
+  > Exemplo: `npx intlayer dictionary push -k`
+
+  > Exemplo: `npx intlayer dictionary push --keep-locale-dictionary`
+
+**Opções de preparação:**
+
+- **`--build`**: Constrói os dicionários antes de enviá-los para garantir que o conteúdo esteja atualizado. True forçará a construção, false pulará a construção, undefined permitirá usar o cache da construção.
+
+**Opções de log:**
+
+- **`--verbose`**: Ativa o log detalhado para depuração. (padrão para true ao usar CLI)
+
+**Opções Git:**
+
+- **`--git-diff`**: Executa apenas nos dicionários que incluem alterações desde a base (padrão `origin/main`) até o branch atual (padrão: `HEAD`).
+- **`--git-diff-base`**: Especifica a referência base para o git diff (padrão `origin/main`).
+- **`--git-diff-current`**: Especifica a referência atual para o git diff (padrão: `HEAD`).
+- **`--uncommitted`**: Inclui alterações não comitadas.
+- **`--unpushed`**: Inclui alterações não enviadas (unpushed).
+- **`--untracked`**: Inclui arquivos não rastreados.
+
+  > Exemplo: `npx intlayer dictionary push --git-diff --git-diff-base origin/main --git-diff-current HEAD`
+
+  > Exemplo: `npx intlayer dictionary push --uncommitted --unpushed --untracked`

package/docs/pt/cli/sdk.md

@@ -0,0 +1,67 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: SDK CLI
+description: Aprenda como usar o SDK CLI do Intlayer no seu próprio código.
+keywords:
+  - SDK
+  - CLI
+  - Intlayer
+  - Programático
+slugs:
+  - doc
+  - concept
+  - cli
+  - sdk
+---
+
+# SDK CLI
+
+O SDK CLI é uma biblioteca que permite usar o CLI do Intlayer no seu próprio código.
+
+```bash packageManager="npm"
+npm install @intlayer/cli --save-dev
+```
+
+```bash packageManager="yarn"
+yarn add @intlayer/cli --save-dev
+```
+
+```bash packageManager="pnpm"
+pnpm add @intlayer/cli --save-dev
+```
+
+Exemplo de uso:
+
+```ts
+import {
+  push,
+  pull,
+  fill,
+  build,
+  listContentDeclaration,
+  testMissingTranslations,
+  docTranslate,
+  docReview,
+  transform,
+} from "@intlayer/cli";
+
+push();
+// ...
+pull();
+// ...
+fill();
+// ...
+build();
+// ...
+listContentDeclaration();
+// ...
+testMissingTranslations();
+// ...
+docTranslate();
+// ...
+docReview();
+// ...
+transform();
+// ...
+```

package/docs/pt/cli/test.md

@@ -0,0 +1,76 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Testar traduções ausentes
+description: Aprenda como testar e identificar traduções ausentes em seus dicionários.
+keywords:
+  - Teste
+  - Traduções Ausentes
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - test
+---
+
+# Testar traduções ausentes
+
+```bash
+npx intlayer content test
+```
+
+## Apelidos:
+
+- `npx intlayer test`
+
+Este comando analisa seus arquivos de declaração de conteúdo para identificar traduções ausentes em todos os locais configurados. Ele fornece um relatório abrangente mostrando quais chaves de tradução estão faltando para quais locais, ajudando você a manter a consistência em seu conteúdo multilíngue.
+
+## Exemplo de saída:
+
+```bash
+pnpm intlayer content test
+Missing translations:
+ - home-page                      - tr         - src/components/HomePage/homePage.content.ts
+ - server-component               - es, tr     - src/components/ServerComponent/serverComponent.content.ts
+ - client-component               - pl, tr     - src/components/ClientComponent/clientComponent.content.ts
+Locales: en, ru, ja, fr, ko, zh, es, de, ar, it, en-GB, pt, hi, tr, pl
+Locais obrigatórios: en
+Locais ausentes: pl, tr, es
+Locais obrigatórios ausentes: -
+Total de locais ausentes: 3
+Total de locais obrigatórios ausentes: 0
+```
+
+## Argumentos:
+
+**Opções de configuração:**
+
+- **`--env`**: Especificar o ambiente (ex.: `development`, `production`).
+- **`--env-file [envFile]`**: Fornecer um arquivo de ambiente personalizado para carregar variáveis.
+- **`--base-dir`**: Especificar o diretório base do projeto.
+
+  > Exemplo: `npx intlayer content test --base-dir ./src --env-file .env.production.local`
+
+- **`--no-cache`**: Desabilitar o cache.
+
+  > Exemplo: `npx intlayer build --no-cache`
+
+**Opções de preparação:**
+
+- **`--build`**: Construir os dicionários antes de enviar para garantir que o conteúdo esteja atualizado. True forçará a construção, false pulará a construção, undefined permitirá usar o cache da construção.
+
+**Opções de log:**
+
+- **`--verbose`**: Ativar logging detalhado para depuração. (padrão para true usando CLI)
+
+  > Exemplo: `npx intlayer content test --verbose`
+
+## Exemplo:
+
+```bash
+npx intlayer content test --verbose
+```
+
+A saída ajuda você a identificar rapidamente quais traduções precisam ser concluídas para garantir que sua aplicação funcione corretamente em todos os locais configurados.

package/docs/pt/cli/transform.md

@@ -0,0 +1,65 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Transformar Componentes
+description: Aprenda como transformar componentes existentes para usar o Intlayer.
+keywords:
+  - Transformar
+  - Componentes
+  - Migração
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - transform
+---
+
+# Transformar componentes
+
+```bash
+npx intlayer transform
+```
+
+Este comando analisa seus arquivos de código para ajudar a migrar componentes existentes para usar o Intlayer. Ele suporta seleção interativa de arquivos ou direcionamento específico de arquivos.
+
+## Apelidos:
+
+- `npx intlayer trans`
+
+## Argumentos:
+
+**Opções de seleção de arquivos:**
+
+- **`-f, --file [files...]`**: Lista de arquivos específicos para transformar. Se não for fornecido, o CLI irá escanear arquivos correspondentes (`**/*.{tsx,jsx,vue,svelte,ts,js}`) e solicitará que você selecione quais deseja transformar.
+
+  > Exemplo: `npx intlayer transform -f src/components/MyComponent.tsx`
+
+**Opções de saída:**
+
+- **`-o, --output-content-declarations [outputContentDeclarations]`**: Diretório para salvar os arquivos gerados de declaração de conteúdo.
+
+  > Exemplo: `npx intlayer transform -o src/content`
+
+- **`--code-only`**: Apenas transforma o código do componente (não escreve declaração de conteúdo).
+
+  > Exemplo: `npx intlayer transform --code-only`
+
+- **`--declaration-only`**: Apenas gera a declaração de conteúdo (não reescreve o componente).
+
+  > Exemplo: `npx intlayer transform --declaration-only`
+
+**Opções de configuração:**
+
+- **`--base-dir`**: Especifica o diretório base do projeto.
+- **`--env`**: Especifica o ambiente.
+- **`--env-file`**: Fornece um arquivo de ambiente personalizado.
+- **`--verbose`**: Ativa o registro detalhado (verbose).
+
+**Plugins necessários:**
+
+O comando transform funciona sem plugins adicionais em arquivos TypeScript / JSX. No entanto, requer que os seguintes plugins estejam instalados para projetos Vue e Svelte:
+
+- **`@intlayer/vue-transformer`**: Para arquivos Vue.
+- **`@intlayer/svelte-transformer`**: Para arquivos Svelte.

package/docs/pt/cli/version.md

@@ -0,0 +1,24 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Verificar a versão da CLI
+description: Saiba como verificar a versão instalada da CLI do Intlayer.
+keywords:
+  - Versão
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - version
+---
+
+# Verificar a versão da CLI
+
+```bash
+npx intlayer --version
+npx intlayer version
+```
+
+Ambos os comandos exibem a versão instalada da CLI do Intlayer.

package/docs/pt/cli/watch.md

@@ -0,0 +1,39 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Monitorar Dicionários
+description: Aprenda como monitorar alterações nos seus arquivos de declaração de conteúdo e construir dicionários automaticamente.
+keywords:
+  - Monitorar
+  - Dicionários
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - watch
+---
+
+# Monitorar Dicionários
+
+```bash
+npx intlayer watch
+```
+
+Este comando irá monitorar alterações nos seus arquivos de declaração de conteúdo e construir os dicionários no diretório `.intlayer`.
+Este comando é o equivalente a `npx intlayer build --watch --skip-prepare`.
+
+## Apelidos:
+
+- `npx intlayer dictionaries watch`
+- `npx intlayer dictionary watch`
+- `npx intlayer dic watch`
+
+## Argumentos:
+
+- **`--with`**: Inicia um comando em paralelo com o monitoramento.
+
+  > Exemplo: `npx intlayer watch --with "next dev --turbopack"`
+
+  > Exemplo: `npx intlayer watch --with "next dev --turbopack"`