Intlayer CLI

Table of Contents

Install Package

Install the necessary packages using npm:

npm install intlayer-cli -g

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

intlayer-cli package

The intlayer-cli package is intended 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 use 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

Core Commands

• Build Dictionaries - Build your dictionaries from content declaration files
• Watch Dictionaries - Watch for changes and automatically build dictionaries
• Check CLI Version - Check the installed Intlayer CLI version

Dictionary Management

• Push Dictionaries - Push dictionaries to the Intlayer editor and CMS
• Pull Dictionaries - Pull dictionaries from the Intlayer editor and CMS
• Fill Dictionaries - Fill, audit, and translate dictionaries using AI
• Test Missing Translations - Test and identify missing translations
• List Content Declaration Files - List all content declaration files in your project

Component Management

• Transform Components - Transform existing components to use Intlayer

Configuration

• Manage Configuration - Get and push your Intlayer configuration to the CMS

Documentation Management

• Translate Document - Automatically translate documentation files using AI
• Review Document - Review documentation files for quality and consistency

Editor & Live Sync

• Editor Commands - Use the Intlayer editor commands
• Live Sync Commands - Use Live Sync to reflect CMS content changes at runtime

Development Tools

• CLI SDK - Use the Intlayer CLI SDK in your own code
• Debug Intlayer Command - Debug and troubleshoot Intlayer CLI issues

Use intlayer commands in your package.json

"scripts": {  "intlayer:build": "npx intlayer build",  "intlayer:watch": "npx intlayer build --watch",  "intlayer:push": "npx intlayer push",  "intlayer:pull": "npx intlayer pull",  "intlayer:fill": "npx intlayer fill",  "intlayer:list": "npx intlayer content list",  "intlayer:test": "npx intlayer content test",  "intlayer:transform": "npx intlayer transform",  "intlayer:doc:translate": "npx intlayer doc translate",  "intlayer:doc:review": "npx intlayer doc review"}

Note: You can also use the shorter aliases:

• npx intlayer list instead of npx intlayer content list
• npx intlayer test instead of npx intlayer content test