Installation

To install Nx on your machine, choose one of the following methods based on your operating system and package manager. You can also use npx to run Nx without installing it globally.

npm

npm add --global nx

Note: You can also use yarn, pnpm, or bun

Homebrew (macOS, Linux)

brew install nx

Chocolatey (Windows)

choco install nx

apt (Ubuntu)

sudo add-apt-repository ppa:nrwl/nx
sudo apt update
sudo apt install nx

Adding Nx to Your Repository

To add Nx to an existing repository, run:

nx init

Note: You can also manually install the nx NPM package and create a nx.json to configure it. Learn more about adopting Nx in an existing project

Starter Repository

To create a starter repository, you can use the create-nx-workspace command. This will create a new Nx workspace with a default configuration and example applications.

npx create-nx-workspace@latest

Update Nx

When you update Nx, Nx will also automatically update your dependencies if you have an Nx plugin installed for that dependency. To update Nx, run:

nx migrate latest

This will create a migrations.json file with any update scripts that need to be run. Run them with:

nx migrate --run-migrations

Update One Major Version at a Time

To avoid potential issues, it is recommended to update one major version of Nx at a time.

Tutorials

Try one of these tutorials for a full walkthrough of what to do after you install Nx:

• TypeScript Monorepo Tutorial
• React Monorepo Tutorial
• Angular Monorepo Tutorial

More Documentation

• Add Nx to an Existing Repository
• Update Nx
• Update Your Global Nx Installation
• Install Nx in a Non-Javascript Repo