0

0

如何在 composer.json 中配置 "bin" 字段来创建命令行工具?

冰火之心

冰火之心

发布时间:2025-11-28 16:57:06

|

895人浏览过

|

来源于php中文网

原创

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

如何在 composer.json 中配置 \

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



确保赋予执行权限:

千图设计室AI海报
千图设计室AI海报

千图网旗下的智能海报在线设计平台

下载
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 脚本就能像真正的命令行工具一样被调用。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

1997

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1324

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1227

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

948

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1402

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1229

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1440

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1303

2023.11.13

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

65

2025.12.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二十四期_PHP8编程
第二十四期_PHP8编程

共86课时 | 3.4万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 2.4万人学习

第二十三期_PHP编程
第二十三期_PHP编程

共93课时 | 6.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号