Can I run a command from package.json bin script?

Question

Is it possible to run a command from a bin script in a package.json ? I know it expects a path to file and trying to run a command there results in an error upon installation (after publishing to npm). Is it possible to run a command like it is in an npm start ?

Examples:

{
  "name": "myscript",
  "version": "1.0.3",
  "bin": {
    "myscript": "app/main.js"
  }
}

This will create a symlink from the app/main.js script to /usr/local/bin/myscript
Instead, this is what I want to achieve:

{
  "name": "myscript",
  "version": "1.0.3",
  "bin": {
    "myscript": "echo hello world"
  }
}

Possible workarounds are also appreciated.

Not according to the docs: docs.npmjs.com/files/package.json#bin — Felix Kling
– Felix Kling, Commented May 8, 2018 at 22:32
Create a .sh file with the contents echo hello world and optionally add the header #!/usr/bin/env bash — Patrick Roberts
– Patrick Roberts, Commented May 8, 2018 at 22:34
@EvyatarMeged echo isn't cross-platform, so why should your bash file be? — Patrick Roberts
– Patrick Roberts, Commented May 8, 2018 at 22:35

Wil Moore III · Accepted Answer · 2021-12-15 23:36:50Z

6

This answer is updated since the old answer was a bit dated and ultimately incorrect. You can now do:

npx myscript

edited Dec 15, 2021 at 23:36

answered May 8, 2018 at 22:37

Wil Moore III

7,2503 gold badges38 silver badges51 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Evya Over a year ago

Thanks for the answer, but upon publication of the package, will I be able to run it with an alias of my choosing (in my example, I just need to call myscript after installation). Seems like I'll have to specify the key in scripts as well ?

user3064538 Over a year ago

What command do I run if I have "bin": "dist/src/cli.js", in my package.json? I've been doing node dist/src/cli.js but is there a simpler command? Ideally something that runs prepare before running the script too, because I need to compile the TypeScript.

Lingster · Accepted Answer · 2020-08-11 09:36:38Z

2

Have you tried running npm link https://docs.npmjs.com/cli/link which would create a link to your binary, then you can just run your script on the command line as myscript.

answered Aug 11, 2020 at 9:36

Lingster

1,12212 silver badges23 bronze badges

Collectives™ on Stack Overflow

Can I run a command from package.json bin script?

2 Answers 2

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related