Intlayer command undefined

Overview

The Intlayer CLI provides a convenient way to control your intlayer content, including building dictionaries, pushing translations, and more. However, it is not essential for your project to function. If you are using the bundler plugin (such as withIntlayer() for Next.js or intlayer() for Vite), Intlayer will automatically build dictionaries during the app build or development server startup. In development mode, it will also watch for changes and automatically rebuild content declaration files.

You can access the intlayer commands in different ways:

Using the intlayer CLI command directly
Using the VSCode extension
Using the @intlayer/cli SDK

Problem

When trying to use the intlayer command, you might encounter this error:

bash

Copy code

Copy the code to the clipboard

'intlayer' is not recognised as an internal or external command,
operable programme or batch file.

Solutions

Try these solutions in order:

Verify the command is installed

bash

Copy code

Copy the code to the clipboard

npx intlayer -h

Expected output:

bash

Copy code

Copy the code to the clipboard

Usage: intlayer [options] [command]

Intlayer CLI

Options:
    -V, --version            output the version number
    -h, --help               display help for command

Commands:
    dictionary|dictionaries  Dictionaries operations
    configuration|config     Configuration operations
    help [command]           display help for command

Install the intlayer-cli package globally

bash

Copy code

Copy the code to the clipboard

npm install intlayer-cli -g -g

It should not be necessary if you've already installed the intlayer package

Install the package globally

bash

Copy code

Copy the code to the clipboard

npm install intlayer -g

Restart your terminal Sometimes a terminal restart is needed to recognise new commands.
Clean and reinstall If the above solutions don't work:

bash

Copy code

Copy the code to the clipboard

rm -rf node_modules package-lock.json
npm install

Verify installation files If the issue persists, check that these files exist:
- node_modules/intlayer/dist/cjs/cli.cjs
- node_modules/intlayer/package.json (should have a bin field referencing ./dist/cjs/cli.cjs)
Check PATH environment variable Make sure the npm global bin directory is in your PATH:

bash

Copy code

Copy the code to the clipboard

# For Unix-based systems (macOS/Linux)
echo $PATH
# Should include something like /usr/local/bin or ~/.npm-global/bin

# For Windows
echo %PATH%
# Should include the npm global bin directory

Use npx with full path If the command is still not found, try using npx with the full path:

bash

Copy code

Copy the code to the clipboard

npx ./node_modules/intlayer/ dictionaries build

Check for conflicting installations

bash

Copy code

Copy the code to the clipboard

# List all globally installed packages
npm list -g --depth=0

# Remove any conflicting global installations
npm uninstall -g intlayer
npm uninstall -g intlayer-cli
# Then reinstall
npm install -g intlayer

Verify Node.js and npm versions Make sure you're using compatible versions:

bash

Copy code

Copy the code to the clipboard

node --version
npm --version

plaintext

Copy code

Copy the code to the clipboard

If you're using an outdated version, consider updating Node.js and npm.

Check for permission issues If you are encountering permission errors:

bash

Copy code

Copy the code to the clipboard

# For Unix-based systems
sudo npm install -g intlayer

# Or change npm's default directory
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
# Add to your ~/.profile or ~/.bashrc:
export PATH=~/.npm-global/bin:$PATH