Install

nr is available on the NPM registry and can be installed using any package manager that can install packages from it.

NPM

npm install --save-dev @darkobits/nr

Yarn

yarn add @darkobits/nr --dev

To verify the installation, you should now be able to run:

npx nr --help

A Note On Global Installations

nr may be installed globally as well, but relying on global dependencies is considered an anti-pattern. Using a local installation means your project can explicitly declare that it depends on another package and, importantly, which version of that package it is compatible with.

However, one downside to a local installation is that users are not always able to invoke locally-installed CLIs directly from the command line, leading to a sub-optimal user experience. To read more about how you can address this, see the following section on configuring your environment.