Fill / audit / translate dictionaries

npx intlayer fill

This command analyzes your content declaration files for potential issues such as missing translations, structural inconsistencies, or type mismatches. If it finds any problems, intlayer fill will propose or apply updates to keep your dictionaries consistent and complete.

Key Points:

• Splits large JSON files into chunks to stay within the AI model's context window limits.
• Retries translation if the output format is incorrect.
• Incorporates application and file-specific context for improved translation accuracy.
• Preserves existing translations by not overwriting them.
• Processes files, chunks, and locales in parallel using a queue system to increase speed.

Aliases:

• npx intlayer dictionaries fill
• npx intlayer dictionary fill
• npx intlayer dic fill

Examples of output:

npx intlayer fillPreparing Intlayer (v7.5.14)Done 76ms@intlayer/ai found - Run process locallyProvider: (default) - Model: (default) - API Key: ✓Affected dictionary keys for processing: app, comp-test, hello-world, lang-switcher - [comp-test]      No locales to fill, Skipping comp-test.content.json - [app]            Processing app.content.tsx - [app]            Filling missing metadata for app.content.tsx - [hello-world]    Processing test.content.ts - [hello-world]   [French (fr)]      Preparing test.content.ts - [hello-world]   [Spanish (es)]     Preparing test.content.ts - [lang-switcher]  Processing langSwitcher.content.ts - [lang-switcher]  Filling missing metadata for langSwitcher.content.ts - [hello-world]    Translation completed successfully for test.content.ts - [lang-switcher] [Spanish (es)]     Preparing langSwitcher.content.ts - [app]           [French (fr)]      Preparing app.content.tsx - [app]           [Spanish (es)]     Preparing app.content.tsx - [hello-world]    Content declaration written to test.content.ts - [app]            Translation completed successfully for app.content.tsx - [app]            Content declaration written to app.content.tsx - [lang-switcher]  Translation completed successfully for langSwitcher.content.ts - [lang-switcher]  Content declaration written to langSwitcher.content.ts

Arguments:

Files list options:

• -f, --file [files...]: A list of specific content declaration files to audit. If not provided, all discovered *.content.{ts,js,mjs,cjs,tsx,jsx,json} based on your configuration file setup will be audited.

  Example: npx intlayer dictionary fill -f src/home/app.content.ts

• -k, --keys [keys...]: Filter dictionaries based on keys. If not provided, all dictionaries will be audited.

  Example: npx intlayer dictionary fill -k key1 key2

• --key [keys...]: Filter dictionaries based on keys (alias for --keys).

  Example: npx intlayer dictionary fill --key key1 key2

• --excluded-keys [excludedKeys...]: Filter out dictionaries based on keys. If not provided, all dictionaries will be audited.

  Example: npx intlayer dictionary fill --excluded-keys key1 key2

• --excluded-key [excludedKeys...]: Filter out dictionaries based on keys (alias for --excluded-keys).

  Example: npx intlayer dictionary fill --excluded-key key1 key2

• --path-filter [pathFilters...]: Filter dictionaries based on glob pattern for file paths.

  Example: npx intlayer dictionary fill --path-filter "src/home/**"

Entry output options:

• --source-locale [sourceLocale]: The source locale to translate from. If not specified, the default locale from your configuration will be used.

• --output-locales [outputLocales...]: Target locales to translate to. If not specified, all locales from your configuration will be used except the source locale.

• --mode [mode]: Translation mode: complete, review. Default is complete. complete will fill all missing content, review will fill missing content and review existing keys.

Git options:

• --git-diff: Only run on dictionaries that includes changes from base (default origin/main) to current branch (default: HEAD).
• --git-diff-base: Specify the base reference for git diff (default origin/main).
• --git-diff-current: Specify the current reference for git diff (default: HEAD).
• --uncommitted: Include uncommitted changes.
• --unpushed: Include unpushed changes.

• --untracked: Include untracked files.

  Example: npx intlayer doc translate --git-diff --git-diff-base origin/main --git-diff-current HEAD

  Example: npx intlayer doc translate --uncommitted --unpushed --untracked

AI options:

• --model [model]: The AI model to use for the translation (e.g., gpt-3.5-turbo).
• --provider [provider]: The AI provider to use for the translation.
• --temperature [temperature]: Temperature setting for the AI model.
• --api-key [apiKey]: Provide your own API key for the AI service.
• --custom-prompt [prompt]: Provide a custom prompt for your translation instructions.
• --application-context [applicationContext]: Provide additional context for the AI translation.

• --data-serialization [dataSerialization]: The data serialization format to use for the AI features of Intlayer. Options: json (standard, reliable), toon (fewer tokens, less consistent).

  Example: npx intlayer fill --model gpt-3.5-turbo --provider openai --temperature 0.5 --api-key sk-1234567890 --application-context "My application is a cat store"

Environment variables options:

• --env: Specify the environment (e.g., development, production).

• --env-file [envFile]: Provide a custom environment file to load variables from.

  Example: npx intlayer fill --env-file .env.production.local

  Example: npx intlayer fill --env production

Configuration options:

• --base-dir: Specify the base directory for the project.

  Example: npx intlayer fill --base-dir ./src

• --no-cache: Disable the cache.

  Example: npx intlayer build --no-cache

Preparation options:

• --build: Build the dictionaries before pushing to ensure the content is up to date. True will force the build, false will skip the build, undefined will allow using the cache of the build.

• --skip-metadata: Skip filling missing metadata (description, title, tags) for dictionaries.

Log options:

• --verbose: Enable verbose logging for debugging. (default to true using CLI)

Example:

npx intlayer fill --file src/home/*.content.ts --source-locale en --output-locales fr es --model gpt-3.5-turbo

This command will translate content from English to French and Spanish for all content declaration files in the src/home/ directory using the GPT-3.5 Turbo model.