Managing your Global Nx Installation

Nx can be ran in a total of 3 ways:

  • Through your package manager (e.g. npx nx, yarn nx, or pnpm exec nx)
  • Through ./nx or ./nx.bat
  • Through a global Nx installation (e.g. nx)

With a global Nx installation, Nx looks for the local copy of Nx in your repo and hands off the process execution to it. This means that whichever version of Nx is installed locally in your repo is still the version of Nx that runs your code. For the most part, this can eliminate any issues that may arise from the global install being outdated.

Installing Nx Globally

Depending on your package manager of choice, you can install Nx with the following commands:

npm install --global nx@latest

Updating your global Nx installation

There are some cases where an issue could arise when using an outdated global installation of Nx. If the structure of your Nx workspace no longer matches up with what the globally installed copy of Nx expects, it may fail to hand off to your local installation properly and instead error. This commonly results in errors such as:

  • Could not find Nx modules in this workspace.
  • The current directory isn't part of an Nx workspace.

If you find yourself in this position, you will need to update your global install of Nx.

In most cases, you can update a globally installed npm package by rerunning the command you used to install it, as described above

If you cannot remember which package manager you installed Nx globally with or are still encountering issues, you can locate other installs of Nx with these commands:

npm list --global nx

You can then remove the extra global installations by running the following commands for the duplicate installations:

npm rm --global nx

Finally, to complete your global installation update, simply reinstall it as described above.