讲师中心 微信公众号
AI工具推荐 视频效率加速

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

浅静酱_1626

浅静酱_1626

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

|

911人浏览过

|

来源于php中文网

原创

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

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

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

什么是 composer run-script

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

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

基本语法

composer run-script [options] [--] [<script>] [<args>...]

  • 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 的工具:

Digital Singer
Digital Singer

将NuwaAI数字形象变成歌手,口型随音频同步,支持背景同步

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

运行方式:

composer run-script test

这将执行 phpunit 测试套件。

4. 使用事件钩子脚本

Composer 内置了许多事件钩子,如 post-install-cmd、pre-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工具

更多
讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

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

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

344

2023.12.25

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

523

2026.04.10

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

307

2026.04.10

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

329

2026.04.10

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

280

2026.04.13

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

383

2026.04.13

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

211

2026.04.14

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

270

2026.04.14

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

80

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn