Intlayer CLI - All Intlayer CLI commands for your multilingual website

Table of Contents

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|tsx|jsx|md|mdx|yaml|yml}. 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

Authentication

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

intlayer login issues an access key (clientId / clientSecret) that every credentialed command uses. The secret is a server-side credential and never reaches your client bundle — see Keeping the access key safe.

Core Commands

• Build Dictionaries - Build your dictionaries from content declaration files
• Watch Dictionaries - Watch for changes and automatically build 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 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

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

Configuration

• Initialize Intlayer - Set up Intlayer in your project with automatic 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

CI/CD & Automation

• CI Command - Run Intlayer commands with auto-injected credentials for CI/CD pipelines

Auditing & Diagnostics

• Scan Website - Measure page size and audit i18n/SEO health of any public URL

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: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",
  "intlayer:scan": "npx intlayer scan https://example.com"
}

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
• npx intlayer projects-list or npx intlayer pl instead of npx intlayer projects list