Composer怎么查看帮助文档 Composer怎么调出指令说明【手册】

2次阅读

composer help 是查看 composer 全局帮助的最快方式,不依赖 composer.json;加命令名如 composer help install 可查具体用法,选项说明在 options 中,断网可用且无中文支持。

Composer怎么查看帮助文档 Composer怎么调出指令说明【手册】

composer help 查看全局帮助

直接运行 composer help 就能列出所有可用命令,这是最快速的入口。它不依赖当前目录是否有 composer.json,适合刚装完 Composer 想摸清底细的时候。

常见错误现象:command not found: composer —— 说明没正确安装或 PATH 未配置,先别查帮助,得先让命令能跑起来。

  • -h--help 效果一样,比如 composer install -h
  • 想看某个命令的详细用法(比如参数、默认行为),一定要带命令名,否则只显示命令列表
  • 输出内容会包含「Usage」「Arguments」「Options」三块,重点盯 Options 里的 --dry-run--no-dev 这类开关

composer help install 查看具体命令文档

每个子命令都有独立帮助页,比如 composer install 的逻辑和 composer update 完全不同,混用参数会报错。运行 composer help install 才能看到它真正支持哪些选项、哪些参数是必填的。

使用场景:CI 脚本里加了 --prefer-dist 却发现没生效?可能你误用了 update 的参数,而 install 默认就走 dist,这个选项对它无效。

  • composer update --help 会告诉你 --with-dependencies 只影响显式列出的包,不会递归更新其子依赖
  • composer require --help 明确写了 package 是必填参数,漏掉就会报 Not enough arguments
  • 某些选项如 --optimize-autoloader 在生产环境有用,但本地开发时开启反而拖慢 autoload 生成速度

没有网络时怎么查本地帮助

Composer 帮助文本是硬编码在源码里的,不依赖远程文档,断网也能用。但如果你看到的帮助是英文,不是因为联网失败,而是系统 locale 或 Composer 自身没配中文语言包 —— 它压根不支持多语言,所有帮助都是英文。

容易踩的坑:有人以为 composer help --lang=zh 存在,试了报错。其实没有语言切换机制,也别去搜“composer 中文手册”,官方不提供,第三方翻译常滞后且不准。

  • 帮助内容来自 vendor/composer/composer/src/Command/ 下各 Command 类的 configure() 方法里写的 ->setHelp()
  • 想确认某参数是否真被支持?别信博客,直接 composer help xxx 看输出最准
  • 某些插件命令(如 composer normalize)的帮助要等插件装好后才能显示,没装就提示 “Command ‘normalize’ is not defined”

help 输出太长看不清怎么办

终端一屏刷不完很正常,别手动滚动找关键行。用管道接 lessgrep 更快:

composer help require | grep -A2 -B2 "dev-master"

这行能快速定位到关于版本约束写法的说明段落。windows 用户可用 findstr 替代 grep

  • composer help | head -n 20 先看前 20 行,快速判断有没有你要的命令
  • Mac/linux 上按 / 键进入 less 搜索模式,输 –no-scripts 回车就能跳转到相关描述
  • 别复制粘贴 help 输出去问别人“这个什么意思”,绝大多数问题答案就在那几行 Options 里,只是没细读

实际用多了会发现,help 文本里藏着很多边界细节:比如 composer dump-autoload --optimize 在 PHP 8.2+ 已被弃用,但 help 里不会标“deprecated”,得看官网 changelog;又比如 --ignore-platform-req 后面必须跟扩展名(如 ext-gd),不能只写 gd,这类坑 help 会写清楚,但容易一眼略过。

text=ZqhQzanResources