Initialise Intlayer

npx intlayer init

The init command installs the Intlayer packages and sets up your framework (configuration file, TypeScript, bundler plugin, middleware/proxy, providers). It's the recommended way to get started with Intlayer.

Everything else (CI workflows, AI skills, MCP server, editor tooling, lint rules, CMS, infrastructure) is opt-in: pick it from the --interactive checklist, or run its dedicated sub-command (see below).

Aliases:

• npx intlayer init

Arguments:

• --project-root [projectRoot] - Optional. Specify the project's root directory. If not provided, the command will search for the project root starting from the current working directory.
• --no-gitignore - Optional. Skips the automatic update of the .gitignore file. If this flag is set, .intlayer will not be added to .gitignore.
• --no-framework-setup - Optional. Only install the packages, without touching the project files.
• --routing <routing> - Optional. Locale routing: prefix-no-default (default), prefix-all, no-prefix, search-params or none.
• -i, --interactive - Optional. Pick the setup steps from a checklist (packages, CI, skills, MCP, VS Code, LSP, lint, CMS, infrastructure, …) instead of running the default set. Needs a terminal: without one (AI agent, CI), the command fails and lists the sub-commands to run instead.
• --no-github-actions - Optional. With --interactive, never scaffold the GitHub Actions workflows, even if selected.

What it does:

The init command performs the following setup tasks:

1. Validates project structure - Ensures you are in a valid project directory with a package.json file.
2. Installs the packages - Installs the missing Intlayer packages for your stack (e.g. react-intlayer, vite-intlayer) and upgrades the outdated ones.
3. Updates .gitignore - Adds .intlayer to your .gitignore file to exclude generated files from version control (can be skipped with --no-gitignore).
4. Configures TypeScript - Updates any tsconfig.json files to include the Intlayer type definitions (.intlayer/**/*.ts).
5. Creates configuration file - Generates intlayer.config.ts (for TypeScript projects) or intlayer.config.mjs (for JavaScript projects) with default settings.
6. Updates the bundler / framework config - Adds the Intlayer plugin to your Vite, Next.js, Nuxt, Astro, … configuration, and scaffolds the middleware/proxy and providers when the framework supports it.

Set up one step at a time

Every step of the --interactive checklist has its own sub-command. They never prompt when their values are passed as flags, so they are safe to run from an AI agent or a CI job.

From an AI agent or a CI job

An AI agent's shell has no terminal, so a prompt cannot be answered. Use the default command, then the sub-commands you need:

npx intlayer init
npx intlayer init skills --platform Claude
npx intlayer init mcp --platform Claude --transport stdio

Without a terminal:

• init skills installs the skills matching your stack unless --skills is set (e.g. --skills Usage Content React).
• init skills and init mcp use the detected AI platform (Claude Code, Cursor, VS Code, Windsurf, …) unless --platform is set, and fail with the list of platforms when none is detected.
• init mcp uses the stdio transport unless --transport is set.
• init infra requires --mode, and init extension only prints the store links unless --browser is set.

The MCP server is always configured inside the project (for Claude Code, in .mcp.json).

Examples:

Basic initialisation:

npx intlayer init

This initialises Intlayer in the current directory, with automatic project root detection.

Initialisation with a custom project root:

npx intlayer init --project-root ./my-project

This initialises Intlayer in the specified directory.

Initialisation without updating .gitignore:

npx intlayer init --no-gitignore

This will set up all configuration files but will not modify your .gitignore file.

Set up the infrastructure (desktop app or self-hosting):

npx intlayer init infra

Downloads and runs the hosted installer (https://intlayer.org/install.sh, or install.ps1 on Windows), which asks how you want to run Intlayer:

• Desktop app - installs the native dashboard on your machine, connected to the Intlayer Cloud.
• All-in-one Docker - dashboard + API + MongoDB + Redis + MinIO in a single container.
• Docker Compose - one container per service, for scalable self-hosting.

Skip the menu with --mode:

npx intlayer init infra --mode compose

The same step is offered by npx intlayer init --interactive. See the init infra reference for the installer settings, and the self-hosting guide for what each mode sets up.

Output Example:

npx intlayer init
Checking Intlayer configuration...
✓ Added .intlayer to .gitignore
✓ Updated tsconfig.json to include intlayer types
✓ Created intlayer.config.ts
✓ Injected import into vite.config.ts
✓ Intlayer init setup complete.

Notes:

• The command is idempotent - you can safely run it multiple times. Already configured steps will be automatically skipped.
• If a configuration file already exists, it will not be overwritten.
• TypeScript configurations without an include array (e.g. solution-style configurations with references) are skipped.
• The command stops with an error if no package.json is found in the project root.