在 composer.json 中通过 "bin" 字段声明可执行脚本路径,Composer 会将其软链接至 vendor/bin/;该脚本须为项目根目录下的 php 文件,具备可执行权限且以 #!/usr/bin/env php 开头。

在 composer.json 中定义二进制文件,核心是通过 "bin" 字段声明可执行脚本路径,Composer 会自动将其软链接到 vendor/bin/ 下,供命令行直接调用。
配置 "bin" 字段指向入口脚本
"bin" 的值必须是项目根目录下某个 PHP 文件的相对路径(通常为 bin/your-command 或 src/YourCommand.php),该文件需具备可执行权限且以 #!/usr/bin/env php 开头(或由 Composer 自动处理 shebang)。
- 在
composer.json中添加字段,例如:
"bin": ["bin/mytool"]
确保 bin/mytool 存在,内容类似:
#!/usr/bin/env php <?php require __DIR__ . '/../vendor/autoload.php'; // 你的命令行逻辑 echo "Hello from mytool!n";
确保脚本有执行权限
linux/macos 下需运行 chmod +x bin/mytool;windows 用户可跳过,Composer 会适配。
- 没有执行权限会导致
vendor/bin/mytool链接存在但无法运行 - 建议在
git中保留可执行位:git update-index --chmod=+x bin/mytool
发布后让其他项目能全局使用
若你开发的是可复用的 CLI 工具(如 phpunit、larastan),还需设置 "type": "project" 或更常见的是 "type": "library" 并在 "autoload" 中注册命名空间——但关键仍是 "bin" 字段被下游项目识别。
- 其他项目
composer require your/package后,your-package的bin就会出现在其vendor/bin/中 - 如想支持全局安装(
composer global require),无需额外配置,Composer 默认处理
验证是否生效
运行 composer install 或 composer update 后,检查 vendor/bin/ 是否生成对应符号链接:
-
ls -l vendor/bin/mytool应显示指向../your-vendor/your-package/bin/mytool - 直接执行
vendor/bin/mytool看输出是否符合预期 - 加到
$PATH后(如export PATH="./vendor/bin:$PATH"),可直接输入mytool调用
基本上就这些。不复杂但容易忽略执行权限和路径准确性。
以上就是如何在composer.json中定义项目的二进制(bin)文件?(创建命令行工具)的详细内容,更多请关注php中文网其它相关文章!