Quickstart with Nx

Get up and running with Nx in just a few minutes by following these simple steps.

1. Install the Nx CLI

   Installing Nx globally is optional. You can use npx to run Nx commands without installing it globally, especially if you're working with Node.js projects.

   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

2. Start fresh or add to existing project

   For JavaScript-based projects you can start with a new workspace using the following command:

   npx create-nx-workspace@latest

   Add to an existing project: (recommended also for non-JS projects)

   npx nx@latest init

   Want remote caching and CI? Connect to Nx Cloud after setup.

   Learn more: Start New Project • Add to Existing

3. Run Your First Commands

   Nx provides powerful task execution with built-in caching. Here are some essential commands:

   Run a task for a single project:

   nx build my-app
   nx test my-lib

   Run tasks for multiple projects:

   nx run-many -t build test lint

   Learn more: Run Tasks • Cache Task Results

4. What's next?

   Now that you've experienced the Nx basics, choose how you want to continue:

   I learn by doing Follow our guided tutorials that teach you from setting up a new project to configuring continuous integration.

   I learn better with videos Check out our bite-sized video lessons that teach you about Nx 101, Nx Release and how to incrementally adopt Nx in an existing project.

   Tell me more about Nx on CI Understand how Nx works on CI, how to configure it and how Nx Cloud helps ensure CI runs fast and efficiently.

   Is Nx just for JavaScript projects? Explore Nx technology integrations and how it can support your specific stack. Even beyond just JavaScript-based projects.