5

I have written an NPM package which has its own CLI commands.

Let's name that package as xyz and imagine it's now avaialable on npmjs.com

So, let's say a user installs this package in his project by running npm install xyz.

And now he wants to run a CLI command provided by xyz package on his terminal in his project.

xyz do_this

Can this be done without installing this package globally by user ? Or without any further configuration for the user ?

Here's some part of the package.json of the xyz package.

{
  "name": "xyz",
  "version": "1.0.0",
  "description": "Description",
  "main": "index.js",
  "preferGlobal": true,
  "bin": "./index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
........
Tharindu Thisarasinghe
  • 3,846
  • 8
  • 39
  • 70

2 Answers2

3

Here's how npm works. When you install a package in the local directory, it installs the executable dependencies files inside node_modules inside the folder with package.json, but if you use --global, it places it globally where the user has set their path. For example, when I run npm install http-server, my executable ends up as ./node_modules/http-server/bin/http-server but when i install it globally, I have it as node_modules/http-server/bin

The work around for this is, if you want to just run the executable, just execute it inside like so ./node_modules/http-server/bin/http-server. If you want it as a command, you'll need too have the user add the directory to their Path so when the user enters the command, the computer looks for the command inside that folder. Here's a guide to adding PATH directories in Linux, you'll just add the directory /pathtofolder/node_modules/http-server/bin/ or whatever your folder is. https://linuxize.com/post/how-to-add-directory-to-path-in-linux/

For example, if I wanted to add http-server from my local folder to my path, I would run

export PATH="/pathtofolder/node_modules/http-server/bin/:$PATH"

Good luck! Let me know how I can help you!

Kyler Chin
  • 188
  • 12
  • 1
    Thanks a lot! So, if I want it as a command, either user has to update the PATH or install it globally ? And If he's calling it from inside the project folder, he needs to run the command like ```./node_modules/http-server/bin/http-server``` ? I hope I got it clear. – Tharindu Thisarasinghe May 24 '21 at 20:55
  • 1
    Since, I want it as a command, like ```sequelize db:migrate```, I should mention in the package README, that the user needs to install it globally right ? Otherwise it's not a convenient command for the user to update his PATH or call it with the full path. – Tharindu Thisarasinghe May 24 '21 at 21:02
  • 1
    That's correct, you wouldn't want to have the user manually add it to the path, it's really complex and not useful. Having a user just run `npm install --global xyz` would probably be the best solution. I hoped this helped! If you think my solution was the correct one, feel free to accept my answer as the solution by pressing the big check mark next to the solution icon! :) – Kyler Chin May 24 '21 at 23:26
  • 3
    Hi Tharindu! I know it's been a long time but I just found something. You can run command line packages without installing it globally. There are 2 more ways. First, install `npm install -g npx` and then run `npx ` that is in the node_modules. That will try to run it. Another way is to run a script inside package.json just be referencing it like `http-server`, no global flag needed. Good luck! – Kyler Chin Jun 29 '21 at 06:38
  • @KylerChin you should add this as an answer instead of a comment. – blockhead Jul 24 '23 at 20:31
0

The easiest way, as also given in the comment above, is to install the needed package locally like

$ node install [@<scope>/]<package>

and run the command later on with npx from same directory

$ npx <package/command>

We do this in our build systems to avoid global installs and their permission issues.

Rick-Rainer Ludwig
  • 2,371
  • 1
  • 26
  • 42