Intlayer CLI - All Intlayer CLI commands for your multilingual website

Table of Contents

Installing the 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.

The intlayer-cli package

The intlayer-cli package is designed to transpile your Intlayer declarations into dictionaries.

This package transpiles all Intlayer files, such as src/**/*.content.{ts|js|mjs|cjs|json|tsx|jsx|md|mdx|yaml|yml}. See how to declare your Intlayer declaration files.

To interpret the Intlayer dictionaries, you can use interpreters, such as react-intlayer or next-intlayer.

Config file support

Intlayer accepts several configuration file formats:

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

To learn how to configure the available languages or other parameters, take a look at the configuration documentation here.

Executing Intlayer commands

Authentication

• Login - Authenticate with the Intlayer CMS and get the access credentials

Core Commands

• Build Dictionaries - Build your dictionaries from your content declaration files
• Watch Dictionaries - Watch for changes and automatically rebuild dictionaries
• Create Standalone Bundle - Create a standalone JavaScript bundle containing Intlayer and specified packages.
• Check CLI Version - Check the installed Intlayer CLI version
• List Projects - List all Intlayer projects in a directory or git repository

Dictionary Management

• Push Dictionaries - Push the dictionaries to the Intlayer Editor and CMS
• Pull Dictionaries - Pull the 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

• Extract Strings - Extract strings from components into a .content file near the component

Configuration

• Initialise Intlayer - Set up Intlayer in your project with automatic configuration
• Manage Configuration - Get your Intlayer configuration and push it to the CMS

Doc Management

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

Editor and Live Sync

• Editor Commands - Use the Intlayer Editor commands
• Live Sync Commands - Use Live Sync to apply content changes from CMS in real time

CI/CD and Automation

• CI Command - Execute Intlayer commands with automatically injected credentials for CI/CD flows

Developer Tools

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

Use the intlayer commands in your package.json file

"scripts": {  "intlayer:init": "npx intlayer init",  "intlayer:login": "npx intlayer login",  "intlayer:build": "npx intlayer build",  "intlayer:watch": "npx intlayer build --watch",  "intlayer:standalone": "npx intlayer standalone --packages intlayer vanilla-intlayer",  "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:extract": "npx intlayer extract",  "intlayer:projects": "npx intlayer projects list",  "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: replaces npx intlayer content list
• npx intlayer test: replaces npx intlayer content test
• npx intlayer projects-list or npx intlayer pl: replaces npx intlayer projects list