如何为Node项目设置无需前缀即可调用的自定义命令关键字？

你提到的newman这类npm包可以直接调用自定义命令，本质是利用了npm内置的bin字段配置能力：npm会根据包中package.json的bin字段声明，在用户安装包时自动将对应的执行入口软链到npm的可执行文件目录。全局安装时软链会放到系统全局npm bin目录（该目录默认已加入系统环境变量PATH），因此用户可以直接在终端输入自定义命令调用。

• 给执行入口文件添加shebang声明
  在你的项目执行入口js文件的第一行添加如下内容，告诉系统该文件需要用Node.js解释执行：

#!/usr/bin/env node
// 你的业务代码从这里开始写

• 配置package.json的bin字段
  在项目根目录的package.json中新增bin配置，格式为"自定义命令名": "入口文件相对路径"，示例如下：

{
  "name": "myproject",
  "version": "1.0.0",
  "main": "index.js",
  // 新增以下配置
  "bin": {
    "myproject": "./bin/run.js"
  }
}

如果你只需要暴露一个可执行命令，也可以简化配置为直接写入口路径，npm会自动用你的包名作为命令名：

"bin": "./bin/run.js"

• 本地测试配置有效性
  在项目根目录执行npm link，npm会将当前本地开发的包软链到全局可执行目录，此时你直接在终端输入myproject就可以触发执行你的入口脚本，验证功能正常后可以执行npm unlink myproject解除本地软链。
• 重新发布你的npm包即可生效。

• 若用户全局安装你的包：执行npm install -g myproject，安装完成后就可以在任意位置直接调用myproject run xxx之类的自定义命令。
• 若用户在项目中本地安装：不需要额外加前缀，直接在项目package.json的scripts字段中引用你的命令即可正常调用，示例：

{
  "scripts": {
    "exec-mytool": "myproject arg0 arg1"
  }
}

用户执行npm run exec-mytool就能正常触发命令，不需要加npx或者路径前缀。

内容的提问来源于stack exchange，提问作者Jayanth Bala