bin

中英双语

许多软件包都有一个或多个可执行文件,他们希望将它们安装到 PATH 中。npm 使这非常容易(事实上,它使用此功能来安装 "npm" 可执行文件。)

要使用它,请在 package.json 中提供一个 bin 字段,它是命令名称到本地文件名的映射。当全局安装此软件包时,该文件将链接到全局 bin 所在的位置,因此可以按名称运行。当此包作为依赖项安装在另一个包中时,该文件将被链接到该包可以直接通过 npm exec 或通过 npm run-script 调用它们时在其他脚本中的名称可用的位置。

例如, myapp 可能有这个:

{
  "bin": {
    "myapp": "./cli.js"
  }
}

因此,当您安装 myapp 时,它会创建一个从 cli.js 脚本到 /usr/local/bin/myapp 的符号链接。

如果您有一个可执行文件,并且它的名称应该是包的名称,那么您可以将其作为字符串提供。例如:

{
  "name": "my-program",
  "version": "1.2.5",
  "bin": "./path/to/program"
}

将与此相同:

{
  "name": "my-program",
  "version": "1.2.5",
  "bin": {
    "my-program": "./path/to/program"
  }
}

请确保您在 bin 中引用的文件以 #!/usr/bin/env node 开头,否则脚本将在没有 node 可执行文件的情况下启动!

请注意,您还可以使用 directories.bin 设置可执行文件。

有关可执行文件的更多信息,请参见 文件夹