Ask your question and get a summary of the document by referencing this page and the AI provider of your choice
By integrating the Intlayer MCP Server to your favourite AI assistant can retrieve all the doc directly from ChatGPT, DeepSeek, Cursor, VSCode, etc.
See MCP Server docIf you have an idea for improving this documentation, please feel free to contribute by submitting a pull request on GitHub.
GitHub link to the documentationCopy doc Markdown to clipboard
Initialize Intlayer
npx intlayer initThe init command automatically sets up Intlayer in your project by configuring necessary files and settings. It's the recommended way to get started with Intlayer.
Aliases:
- npx intlayer init
Arguments:
- --project-root [projectRoot] - Optional. Specify the project root directory. If not provided, the command will search for the project root starting from the current working directory.
What it does:
The init command performs the following setup tasks:
- Validates project structure - Ensures you're in a valid project directory with a package.json file
- Updates .gitignore - Adds .intlayer to your .gitignore file to exclude generated files from version control
- Configures TypeScript - Updates all tsconfig.json files to include Intlayer type definitions (.intlayer/**/*.ts)
- Creates configuration file - Generates an intlayer.config.ts (for TypeScript projects) or intlayer.config.mjs (for JavaScript projects) with default settings
- Updates Vite config - If a Vite configuration file is detected, adds the vite-intlayer plugin import
- Updates Next.js config - If a Next.js configuration file is detected, adds the next-intlayer plugin import
Examples:
Basic initialization:
npx intlayer initThis will initialize Intlayer in the current directory, automatically detecting the project root.
Initialize with custom project root:
npx intlayer init --project-root ./my-projectThis will initialize Intlayer in the specified directory.
Example output:
npx intlayer initChecking Intlayer configuration...✓ Added .intlayer to .gitignore✓ Updated tsconfig.json to include intlayer typesCreated intlayer.config.ts✓ Injected import into vite.config.ts✓ Intlayer init setup complete.Notes:
- The command is idempotent - you can run it multiple times safely. It will skip steps that are already configured.
- If a configuration file already exists, it won't be overwritten.
- TypeScript config files without an include array (e.g., solution-style configs with references) are skipped.
- The command will exit with an error if no package.json is found in the project root.