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"
    }
}

运行方式:

Bandy AI
Bandy AI

全球领先的电商设计Agent

下载
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 可以显著提升开发效率,让项目自动化更简洁可控。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

154

2023.12.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

419

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

535

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

require的用法
require的用法

require的用法有引入模块、导入类或方法、执行特定任务。想了解更多require的相关内容,可以阅读本专题下面的文章。

466

2023.11.27

windows查看端口占用情况
windows查看端口占用情况

Windows端口可以认为是计算机与外界通讯交流的出入口。逻辑意义上的端口一般是指TCP/IP协议中的端口,端口号的范围从0到65535,比如用于浏览网页服务的80端口,用于FTP服务的21端口等等。怎么查看windows端口占用情况呢?php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

762

2023.07.26

查看端口占用情况windows
查看端口占用情况windows

端口占用是指与端口关联的软件占用端口而使得其他应用程序无法使用这些端口,端口占用问题是计算机系统编程领域的一个常见问题,端口占用的根本原因可能是操作系统的一些错误,服务器也可能会出现端口占用问题。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1129

2023.07.27

俄罗斯Yandex引擎入口
俄罗斯Yandex引擎入口

2026年俄罗斯Yandex搜索引擎最新入口汇总,涵盖免登录、多语言支持、无广告视频播放及本地化服务等核心功能。阅读专题下面的文章了解更多详细内容。

391

2026.01.28

热门下载

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

精品课程

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

共137课时 | 10万人学习

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

共6课时 | 11.2万人学习

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

共13课时 | 0.9万人学习

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

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