bin字段用于定义PHP可执行脚本,Composer会将其链接到vendor/bin目录;在composer.json中配置bin数组指定脚本路径,如"bin/my-command",需设置执行权限和Shebang,并在脚本中检查CLI模式及引入自动加载器,安装后即可通过命令行运行。

在 composer.json 中配置 "bin" 字段,可以让 Composer 自动将 PHP 脚本安装为可执行的命令行工具。当你发布一个包或在本地项目中定义 CLI 工具时,这个功能非常有用。
什么是 "bin" 字段?
"bin" 字段用于指定一个或多个可执行脚本文件(通常是 PHP 文件),Composer 会把这些文件链接到全局或项目的 vendor/bin 目录下,使它们可以通过命令行直接运行。
如何配置 bin 字段
在 composer.json 中添加 bin 键,并提供一个包含脚本路径的数组:
{
"name": "your-vendor/cli-tool",
"bin": [
"bin/my-command",
"bin/another-command"
],
"require": {}
}
其中:
- bin/my-command 是一个可执行的 PHP 脚本文件路径。
- 该文件必须有执行权限(Unix 系统下可通过
chmod +x bin/my-command设置)。 - 文件开头应包含正确的 Shebang(如
#!/usr/bin/env php)。
编写可执行脚本示例
创建文件 bin/my-command:
#!/usr/bin/env php
确保赋予执行权限:
chmod +x bin/my-command安装与使用
当你通过 composer require your-vendor/cli-tool 安装这个包时,Composer 会自动把 my-command 链接到 vendor/bin/my-command。
你可以这样运行它:
php vendor/bin/my-command如果使用全局安装,且 Composer 的全局 bin 目录在系统 PATH 中,可以直接运行:
my-command注意事项
- 脚本文件应避免使用
.php扩展名,以便更像原生命令。 - Composer 不会重写已存在的同名命令,避免冲突。
- 推荐在脚本中引入自动加载器(
require __DIR__ . '/../vendor/autoload.php';),以便使用依赖库。
基本上就这些。正确配置 "bin" 后,你的 PHP 脚本就能像真正的命令行工具一样被调用。










