Getting Started

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

1

Install Nx

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 add --global nx

Note: You can also use Yarn, pnpm, or Bun

2

Set Up Your Editor

Nx Console is an editor extension that integrates Nx seamlessly into your development workflow with project details views, visual migration UI, command palette integration, and CI pipeline notifications.

Visual Studio Code

Install Nx Console for VSCodeThe official VSCode extension for Nx.

IntelliJ IDEA
3

Configure Your AI Assistant

Nx Console automatically configures and exposes the Nx MCP server. You'll receive a notification to "Improve Copilot/AI agent with Nx-specific context" - click "Yes" to automatically configure it.

VS Code showing the Nx MCP installation prompt

If you miss the notification, run nx.configureMcpServer from the command palette (Ctrl/Cmd + Shift + P).

For other MCP-compatible clients like Claude Desktop:

mcp.json
1{ 2 "servers": { 3 "nx-mcp": { 4 "command": "npx", 5 "args": ["nx-mcp@latest", "/path/to/your/workspace"] 6 } 7 } 8} 9

Replace /path/to/your/workspace with your workspace path. Learn more about how Nx improves your AI assistant.

4

Choose Your Path

Now that you have Nx installed and your development environment configured, choose how you want to proceed:

Create a New Project

Start fresh with a new Nx workspace using your preferred technology stack

Add to Existing Project

Integrate Nx into your existing repository to leverage caching and speed up CI

Follow a Tutorial

Learn Nx through hands-on tutorials for different technology stacks

Explore Nx Features

Discover all the powerful features that Nx offers