ni

Use the right package manager

Package Manager
antfu-collective/ni@antfu/ni

README

ni


npm i in a yarn project, again? F\\k!

ni - use the right package manager

  1. ```
  2. npm i -g @antfu/ni
  3. ```

npm · yarn · pnpm · bun


ni - install


  1. ```bash
  2. ni

  4. # npm install
  5. # yarn install
  6. # pnpm install
  7. # bun install
  8. ```

  1. ```bash
  2. ni vite

  4. # npm i vite
  5. # yarn add vite
  6. # pnpm add vite
  7. # bun add vite
  8. ```

  1. ```bash
  2. ni @types/node -D

  4. # npm i @types/node -D
  5. # yarn add @types/node -D
  6. # pnpm add -D @types/node
  7. # bun add -d @types/node
  8. ```

  1. ```bash
  2. ni --frozen

  4. # npm ci
  5. # yarn install --frozen-lockfile (Yarn 1)
  6. # yarn install --immutable (Yarn Berry)
  7. # pnpm install --frozen-lockfile
  8. # bun install --no-save
  9. ```

  1. ```bash
  2. ni -g eslint

  4. # npm i -g eslint
  5. # yarn global add eslint (Yarn 1)
  6. # pnpm add -g eslint
  7. # bun add -g eslint

  9. # this uses default agent, regardless your current working directory
  10. ```



nr - run


  1. ```bash
  2. nr dev --port=3000

  4. # npm run dev -- --port=3000
  5. # yarn run dev --port=3000
  6. # pnpm run dev --port=3000
  7. # bun run dev --port=3000
  8. ```

  1. ```bash
  2. nr

  4. # interactively select the script to run
  5. # supports https://www.npmjs.com/package/npm-scripts-info convention
  6. ```

  1. ```bash
  2. nr -

  4. # rerun the last command
  5. ```



nlx - download & execute


  1. ```bash
  2. nlx vitest

  4. # npx vitest
  5. # yarn dlx vitest
  6. # pnpm dlx vitest
  7. # bunx vitest
  8. ```



nu - upgrade


  1. ```bash
  2. nu

  4. # npm upgrade
  5. # yarn upgrade (Yarn 1)
  6. # yarn up (Yarn Berry)
  7. # pnpm update
  8. # bun update
  9. ```

  1. ```bash
  2. nu -i

  4. # (not available for npm & bun)
  5. # yarn upgrade-interactive (Yarn 1)
  6. # yarn up -i (Yarn Berry)
  7. # pnpm update -i
  8. ```



nun - uninstall


  1. ```bash
  2. nun webpack

  4. # npm uninstall webpack
  5. # yarn remove webpack
  6. # pnpm remove webpack
  7. # bun remove webpack
  8. ```

  1. ```bash
  2. nun -g silent

  4. # npm uninstall -g silent
  5. # yarn global remove silent
  6. # pnpm remove -g silent
  7. # bun remove -g silent
  8. ```

nci - clean install


  1. ```bash
  2. nci

  4. # npm ci
  5. # yarn install --frozen-lockfile
  6. # pnpm install --frozen-lockfile
  7. # bun install --no-save
  8. ```

if the corresponding node manager is not present, this command will install it globally along the way.



na - agent alias


  1. ```bash
  2. na

  4. # npm
  5. # yarn
  6. # pnpm
  7. # bun
  8. ```

  1. ```bash
  2. na run foo

  4. # npm run foo
  5. # yarn run foo
  6. # pnpm run foo
  7. # bun run foo
  8. ```

Global Flags


  1. ```bash
  2. # ?               | Print the command execution depends on the agent
  3. ni vite ?

  5. # -C              | Change directory before running the command
  6. ni -C packages/foo vite
  7. nr -C playground dev

  9. # -v, --version   | Show version number
  10. ni -v

  12. # -h, --help      | Show help
  13. ni -h
  14. ```



Config


  1. ```ini
  2. ; ~/.nirc

  4. ; fallback when no lock found
  5. defaultAgent=npm # default "prompt"

  7. ; for global installs
  8. globalAgent=npm
  9. ```

  1. ```bash
  2. # ~/.bashrc

  4. # custom configuration file path
  5. export NI_CONFIG_FILE="$HOME/.config/ni/nirc"
  6. ```

  1. ```ps
  2. # for Windows

  4. # custom configuration file path in PowerShell accessible within the `$profile` path
  5. $Env:NI_CONFIG_FILE = 'C:\to\your\config\location'
  6. ```



Integrations


asdf


You can also install ni via the 3rd-party asdf-plugin maintained by CanRau

  1. ```bash
  2. # first add the plugin
  3. asdf plugin add ni https://github.com/CanRau/asdf-ni.git

  5. # then install the latest version
  6. asdf install ni latest

  8. # and make it globally available
  9. asdf global ni latest
  10. ```

How?


ni assumes that you work with lockfiles (and you should)

Before it runs, it will detect your yarn.lock / pnpm-lock.yaml / package-lock.json / bun.lockb to know current package manager (or packageManager field in your packages.json if specified), and runs the corresponding commands.

Trouble shooting


Conflicts with PowerShell


PowerShell comes with a built-in alias ni for the New-Item cmdlet. To remove the alias in your current PowerShell session in favor of this package, use the following command:

  1. ```PowerShell
  2. 'Remove-Item Alias:ni -Force -ErrorAction Ignore'
  3. ```

If you want to persist the changes, you can add them to your PowerShell profile. The profile path is accessible within the $profile variable. The ps1 profile file can normally be found at

- PowerShell 5 (Windows PowerShell): C:\Users\USERNAME\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1
- PowerShell 7: C:\Users\USERNAME\Documents\PowerShell\Microsoft.PowerShell_profile.ps1
- VSCode: C:\Users\USERNAME\Documents\PowerShell\Microsoft.VSCode_profile.ps1

You can use the following script to remove the alias at shell start by adding the above command to your profile:

  1. ```PowerShell
  2. if (-not (Test-Path $profile)) {
  3.   New-Item -ItemType File -Path (Split-Path $profile) -Force -Name (Split-Path $profile -Leaf)
  4. }

  6. $profileEntry = 'Remove-Item Alias:ni -Force -ErrorAction Ignore'
  7. $profileContent = Get-Content $profile
  8. if ($profileContent -notcontains $profileEntry) {
  9.   ("`n" + $profileEntry) | Out-File $profile -Append -Force -Encoding UTF8
  10. }
  11. ```

nx and nix is no longer available


We renamed nx/nix to nlx to avoid conflicts with the other existing tools - nx and nix. You can always alias them back on your shell configuration file (.zshrc, .bashrc, etc).

  1. ```bash
  2. alias nx="nlx"
  3. # or
  4. alias nix="nlx"
  5. ```