← 中文资源

简体中文版本

用 bin 条目打包 Node CLI

通过 package.json 的 bin 映射与可执行 shebang 发布 Node CLI,使其能以正确名称安装为全局命令。

阅读英文原文

目标

全局安装后没有可执行命令,因为缺少 bin 条目。本配方在入口文件加 shebang、在 package.json 声明 bin 名称并限定 files,使 npm link 或安装后生成对应命令;提醒在 Unix 上需可执行位,Windows 上应依赖 npm 生成的 shim 而非依赖 shebang。

步骤要点

  1. 在入口文件添加 shebang。
  2. 在 package.json 声明 bin 名称与 files。
  3. 提交可执行位或在打包步骤 chmod。
  4. 安装后验证命令名与入口一致。
#!/usr/bin/env node
// src/cli.js
console.log('tool runs');

排错提示

  • Unix 上缺少可执行位会 Permission denied。
  • Windows 不应依赖 shebang,需用 npm shim。
  • 不处理更新与版本。

适用边界

  • 全局安装需要可写前缀。
  • shebang 在 Windows 可移植性差。