Skip to content

Latest commit

 

History

History
195 lines (153 loc) · 7.8 KB

File metadata and controls

195 lines (153 loc) · 7.8 KB
createdAt 2024-08-11
updatedAt 2026-03-31
title CLI - All Intlayer CLI commands for your multilingual website
description Discover how to use the Intlayer CLI to manage your multilingual website. Follow the steps in this online documentation to set up your project in a few minutes.
keywords
CLI
Command Line Interface
Internationalization
Documentation
Intlayer
Next.js
JavaScript
React
slugs
doc
concept
cli
history
version date changes
8.6.4
2026-03-31
Add standalone command
version date changes
7.5.11
2026-01-06
Add CI command
version date changes
7.5.11
2026-01-06
Add projects list command
version date changes
7.5.9
2025-12-30
Add init command
version date changes
7.2.3
2025-11-22
Add extract command
version date changes
7.1.0
2025-11-05
Add skipIfExists option to translate command
version date changes
6.1.4
2025-01-27
Add aliases for CLI arguments and commands
version date changes
6.1.3
2025-10-05
Add build option to commands
version date changes
6.1.2
2025-09-26
Add version command
version date changes
6.1.0
2025-09-26
Set verbose option to default to true using CLI
version date changes
6.1.0
2025-09-23
Add watch command and with option
version date changes
6.0.1
2025-09-23
Add editor command
version date changes
6.0.0
2025-09-17
Add content test and list command
version date changes
5.5.11
2025-07-11
Update CLI command parameters documentation
version date changes
5.5.10
2025-06-29
Init history

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
yarn add intlayer-cli -g
pnpm add intlayer-cli -g
bun add 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

Core Commands

Dictionary Management

Component Management

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

Configuration

Documentation Management

Editor & Live Sync

CI/CD & Automation

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

Development Tools

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"
}

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