Intlayer CLI

Install Package

Install the necessary packages using npm:

npm install intlayer-cli -g

If intlayer package is already installed, the cli is automatically installed. You can skip this step.

intlayer-cli package

intlayer-cli package intend to transpile your intlayer declarations into dictionaries.

This package will transpile all intlayer files, such as src/**/*.content.{ts|js|mjs|cjs|json}. See how to declare your Intlayer declaration files.

To interpret intlayer dictionaries you can interpreters, such as react-intlayer, or next-intlayer

Configuration File Support

Intlayer accepts multiple configuration file formats:

• intlayer.config.ts
• intlayer.config.js
• intlayer.config.json
• intlayer.config.cjs
• intlayer.config.mjs
• .intlayerrc

To see how to configure available locales, or other parameters, refer to the configuration documentation here.

Run intlayer commands

Build dictionaries

To build your dictionaries, you can run the commands:

npx intlayer dictionaries build

or in watch mode

npx intlayer dictionaries build --watch

This command will find your declaration content files as default as ./src/**/*.content.{ts|js|mjs|cjs|json|tsx|jsx}. And build the dictionaries in the .intlayer directory.

Push dictionaries

npx intlayer dictionary push

If intlayer editor is installed, you can also push dictionaries to the editor. This command will allow to make the dictionaries available to the editor. By this way, you can share your dictionaries with your team and edit your content without editing the code of your application.

Arguments:

• -d, --dictionaries: IDs of the dictionaries to push. If not specified, all dictionaries will be pushed. > Example: npx intlayer dictionary push -d my-dictionary-id my-other-dictionary-id
• -r, --deleteLocaleDictionary: Skip the question that asks to delete the locales directories once the dictionaries are pushed, and remove them. By default, if the dictionary is defined locally, it will overwrite distant dictionaries content. > Example: npx intlayer dictionary push -r
• -k, --keepLocaleDictionary: Skip the question that asks to delete the locales directories once the dictionaries are pushed, and keep them. By default, if the dictionary is defined locally, it will overwrite distant dictionaries content. > Example: npx intlayer dictionary push -k
• --env: Specify the environment (e.g., development, production).
• --env-file: Provide a custom environment file to load variables from.
• --base-dir: Specify the base directory for the project.
• --verbose: Enable verbose logging for debugging.
• --git-diff: Only run on dictionaries with unpushed changes.
• --git-diff-base: Specify the base reference for git diff.
• --git-diff-current: Specify the current reference for git diff.
• --uncommitted: Include uncommitted changes.
• --unpushed: Include unpushed changes.
• --untracked: Include untracked files.

Pull distant dictionaries

npx intlayer dictionary pull

If intlayer editor is installed, you can also pull dictionaries from the editor. By this way, you can overwrite the content of your dictionaries for the need of your application.

Arguments:

• -d, --dictionaries: IDs of the dictionaries to pull. If not specified, all dictionaries will be pulled. > Example: npx intlayer dictionary pull -d my-dictionary-id my-other-dictionary-id
• --newDictionariesPath: Path to the directory where the new dictionaries will be saved. If not specified, the new dictionaries will be saved in the ./intlayer-dictionaries directory of the project. If a filePath field is specified in your dictionary content, the dictionaries will not consider this argument and will be saved in the specified filePath directory.
• --env: Specify the environment (e.g., development, production).
• --env-file: Provide a custom environment file to load variables from.
• --base-dir: Specify the base directory for the project.
• --verbose: Enable verbose logging for debugging.

Audit dictionaries

npx intlayer audit

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 audit will propose or apply updates to keep your dictionaries consistent and complete.

Arguments:

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

• --exclude [excludedGlobs...]
  Globs pattern to exclude from the audit (e.g. --exclude "src/test/**").

• --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', or 'missing-only'. Default is 'missing-only'.

• --git-diff
  Only run on dictionaries with unpushed changes in the git repository.

• --git-diff-base
  Specify the base reference for git diff.

• --git-diff-current
  Specify the current reference for git diff.

• --uncommitted
  Include uncommitted changes.

• --unpushed
  Include unpushed changes.

• --untracked
  Include untracked files.

• --keys [keys...]
  Filter dictionaries based on specified keys.

• --excluded-keys [excludedKeys...]
  Filter out dictionaries based on specified keys.

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

• --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.

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

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

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

• --verbose
  Enable verbose logging for debugging.

Example:

npx intlayer audit --exclude "tests/**" --model gpt-3.5-turbo

This command will ignore any files under tests/** and use the gpt-3.5-turbo model to audit the discovered content declaration files. If any issues are found, like missing translations, they will be corrected in-place, preserving the original file structure.

Manage Configuration

Get Configuration

The get configuration command retrieves the current configuration for Intlayer, particularly the locale settings. This is useful for verifying your setup.

npx intlayer config get

Arguments:

• --env: Specify the environment (e.g., development, production).
• --env-file: Provide a custom environment file to load variables from.
• --base-dir: Specify the base directory for the project.
• --verbose: Enable verbose logging for debugging.

Push Configuration

The push configuration command uploads your configuration to the Intlayer CMS and editor. This step is necessary to enable the use of distant dictionaries in the Intlayer Visual Editor.

npx intlayer config push

Arguments:

• --env: Specify the environment (e.g., development, production).
• --env-file: Provide a custom environment file to load variables from.
• --base-dir: Specify the base directory for the project.
• --verbose: Enable verbose logging for debugging.

By pushing the configuration, your project is fully integrated with the Intlayer CMS, enabling seamless dictionary management across teams.

Use intlayer commands in your package.json

"scripts": {  "intlayer:build": "npx intlayer dictionaries build",  "intlayer:watch": "npx intlayer dictionaries build --watch",  "intlayer:push": "npx intlayer dictionary push",  "intlayer:pull": "npx intlayer dictionary pull",  "intlayer:audit": "npx intlayer audit"}