在 package.json 中配置 bin 字段,可以将脚本映射为全局可执行命令。只需将 bin 设为一个对象,键名即为你希望使用的命令行名称,值则是相对于包根目录的脚本路径。安装该包后,npm 会自动创建指向这些脚本的符号链接或包装脚本。

如何定义单个命令并指定入口文件
要定义单个命令,需要在 package.json 中添加 bin 字段,其值为一个对象。对象的键是命令名,值是入口文件的相对路径。例如,若有一个名为 cli.js 的文件位于包根目录,且你想通过 my-tool 来调用它,配置如下:

{
"name": "my-cli-tool",
"version": "1.0.0",
"description": "A simple CLI tool",
"main": "index.js",
"bin": {
"my-tool": "./cli.js"
},
"files": [
"cli.js"
],
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC"
}
确保 cli.js 文件具有可执行权限(在 Linux/macOS 上需运行 chmod +x cli.js),并且第一行包含 shebang(如 #!/usr/bin/env node)。这样,当用户运行 npm install -g . 时,系统就能识别 my-tool 命令。
如何配置多个命令共享同一个入口
如果希望多个命令别名指向同一个脚本,可以在 bin 对象中定义多个键,但它们的值都指向同一个文件。例如,同时支持 my-tool 和 mt 两个命令:

使用 extruct 从原始 HTML 中提取机器可读的元数据,以便代理可以在不依赖脆弱的全页解析的情况下对页面进行分类、去重或丰富。它最适合元数据采集工作流,而不适用于爬取整个网站或渲染 JavaScript 密集型页面。
{
"name": "my-cli-tool",
"version": "1.0.0",
"bin": {
"my-tool": "./cli.js",
"mt": "./cli.js"
},
"files": [
"cli.js"
]
}
这种配置下,cli.js 需要能够区分被调用的命令名。通常可以通过检查 process.argv[1] 来获取实际执行的命令路径,从而决定行为。例如:
const fs = require('fs');
const path = require('path');
// 获取当前执行的脚本路径
const scriptPath = process.argv[1];
const scriptName = path.basename(scriptPath);
console.log(`Command executed: ${scriptName}`);
if (scriptName === 'my-tool') {
console.log('Running my-tool specific logic');
} else if (scriptName === 'mt') {
console.log('Running mt specific logic');
} else {
console.log('Unknown command');
}
这样,无论用户输入 my-tool 还是 mt,都会执行同一段代码,但可以根据命令名做出不同响应。
当入口文件不存在时会发生什么
如果在 package.json 中指定的入口文件路径不存在,npm 在安装过程中会抛出错误,导致安装失败。例如,若 bin 配置为 {"my-tool": "./nonexistent.js"},而 nonexistent.js 文件并未创建,则运行 npm install -g . 时会看到类似以下的错误信息:
npm ERR! code ENOENT npm ERR! syscall open npm ERR! path /path/to/package/nonexistent.js npm ERR! errno -2 npm ERR! enoent ENOENT: no such file or directory, open '/path/to/package/nonexistent.js' npm ERR! enoent This is related to npm not being able to find a file.
因此,务必确保 bin 字段中指定的所有文件都存在,并且路径正确。可以使用 files 字段明确列出需要发布的文件,以避免遗漏。
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南










