Installation
You can go straight ahead and setup a new Nx powered project without even having to install it. Just use the create-nx-workspace
command:
npm create nx-workspace
This will guide you through the setup, asking whether you want a monorepo or a standalone app and whether you want to start with a blank template or with a preconfigured template.
~/workspace❯
npm create nx-workspace
? Choose what to create …
Package-based monorepo: Nx makes it fast, but lets you run things your way.
Integrated monorepo: Nx configures your favorite frameworks and lets you focus on shipping features.
Standalone React app: Nx configures Vite (or Webpack), ESLint, and Cypress.
Standalone Angular app: Nx configures Jest, ESLint and Cypress.
Standalone Node app: Nx configures a framework (ex. Express), esbuild, ESlint and Jest.
Once you've created your workspace, you can
- run single tasks with
npx nx <target> <project>
- run multiple tasks with
npx nx run-many --targets=<target1>,<target2>
Learn more about running tasks.
Installing Nx into an existing repository
If you already have a repository, you can just run
npx nx@latest init
Nx will figure out the structure of your workspace and auto-configure itself.
You can also manually install the nx
NPM package and then create a nx.json to configure it.
Learn more about adopting Nx in an existing project
Installing Nx Globally
If you really want to install Nx globally, you can. Depending on your package manager of choice, use one of the following commands:
npm install --global nx@latest
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.
Learn more about managing and troubleshooting a global Nx installation.