0

0

composer run-script 命令的详细用法与实例

下次还敢

下次还敢

发布时间:2025-11-21 18:07:51

|

891人浏览过

|

来源于php中文网

原创

composer run-script用于执行composer.json中定义的脚本,支持自定义命令、参数传递、多命令组合及跨平台兼容,提升PHP项目自动化效率。

composer run-script 命令的详细用法与实例

在使用 Composer 管理 PHP 项目时,composer run-script 是一个非常实用的命令,用于手动触发定义在 composer.json 文件中的自定义脚本或内置脚本。它可以帮助你自动化执行诸如测试、构建、清理、部署等任务。

什么是 composer run-script

composer run-script 命令允许你运行 composer.jsonscripts 字段下定义的脚本。这些脚本可以是 shell 命令、PHP 脚本、Phar 工具调用等。

该命令不会自动运行依赖脚本(比如 post-install-cmd 不会因为执行 install 而被重复触发),适合用于手动调试或按需执行特定任务。

基本语法

composer run-script [options] [--] [

  • script:要运行的脚本名称(必须存在于 scripts 配置中)
  • args:传递给脚本的额外参数(可选)
  • --timeout=秒数:设置脚本执行超时时间
  • --dev:启用 dev 模式,加载 require-dev 中的脚本(默认已启用)
  • --no-dev:禁用 dev 模式,不加载 require-dev 脚本

常见脚本类型与实例

以下是几种常见的脚本用途和实际示例。

1. 定义并运行自定义脚本

composer.json 中添加一个自定义脚本:

{
    "scripts": {
        "hello": "echo 'Hello, Composer!'"
    }
}

运行该脚本:

composer run-script hello

输出:

Executing command (CWD): echo 'Hello, Composer!'
Hello, Composer!

2. 传递参数给脚本

你可以将参数传递给脚本。例如定义一个接收名字的脚本:

{
    "scripts": {
        "greet": "echo 'Hi, $1'"
    }
}

运行并传参:

composer run-script greet -- John

输出:

Hi, John

注意:参数通过 shell 变量 $1, $2 等访问(Linux/macOS)。Windows 下可能需要使用 %1%

3. 执行 PHP 脚本或工具

你可以运行本地 PHP 脚本或安装在 vendor/bin 的工具:

{
    "scripts": {
        "test": "phpunit",
        "lint": "php -l src/*.php",
        "build": "php build.php"
    }
}

运行方式:

Lifetoon
Lifetoon

免费的AI漫画创作平台

下载
composer run-script test

这将执行 phpunit 测试套件。

4. 使用事件钩子脚本

Composer 内置了许多事件钩子,如 post-install-cmdpre-update-dump 等。虽然它们通常自动触发,但也可以手动运行:

composer run-script post-install-cmd

例如,某些项目在安装后需要生成 autoload 文件或清除缓存,这个命令可用于重新触发这些操作。

5. 复合脚本与多命令执行

使用 &&; 连接多个命令:

{
    "scripts": {
        "deploy": "git pull && composer install && php clear-cache.php"
    }
}

运行:

composer run-script deploy

该命令会依次拉取代码、安装依赖、清除缓存。

6. 跨平台兼容脚本

为避免平台差异问题,推荐使用 PHP 脚本封装逻辑,或使用 Composer 提供的 cross-exec 包:

{
    "scripts": {
        "start": [
            "@php server.php"
        ]
    }
}

其中 @php 会自动映射到当前 PHP 可执行文件,更安全可靠。

7. 调试脚本执行过程

使用 -v(verbose)查看详细执行信息:

composer run-script hello -v

输出会显示执行路径和完整命令。

若脚本卡住或超时,可通过设置超时时间控制:

composer run-script long-task --timeout=300

基本上就这些。合理使用 composer run-script 可以显著提升开发效率,让项目自动化更简洁可控。

相关专题

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

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

1995

2023.09.01

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

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

1320

2023.10.11

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

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

1225

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数据库相关内容,可以阅读本专题下面的文章。

1400

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

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.2万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 6.9万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.8万人学习

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

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