如何让composer在安装一个包时显示其README文件

Composer安装后不会自动显示README，但可通过配置post-install-cmd脚本查找并输出vendor目录下包的README文件内容，或手动查看本地README.md，推荐使用composer show命令获取包的repository和homepage链接，在浏览器中在线阅读文档。

Composer 本身在安装包时不会自动显示 README 文件，但你可以通过一些方法在安装后快速查看包的说明文档。目前没有内置选项让 Composer 安装完立即输出 README 内容，但可以通过以下方式实现类似效果。

1. 使用 post-install-cmd 脚本自动打开或显示 README

例如，假设你刚安装了一个位于 vendor/package-name/ 的包，通常其 README 文件为 README.md 或 README。你可以写一个简单的脚本读取并输出内容：

{
    "scripts": {
        "post-update-cmd": [
            "@show-readme"
        ],
        "post-install-cmd": [
            "@show-readme"
        ],
        "show-readme": "if [ -f 'vendor/autoload.php' ]; then find vendor/ -maxdepth 2 -name 'README.md' -o -name 'README' | head -n 5 | xargs cat; fi"
    }
}

这个脚本会在安装或更新后查找最近安装包中的 README 文件并输出前几个匹配的内容。注意：它不会精确识别“刚刚安装”的包，因为 Composer 没有提供该上下文。

芦笋演示

一键出成片的录屏演示软件，专为制作产品演示、教学课程和使用教程而设计。

34

查看详情

2. 手动查看包的 README

• 进入 vendor/作者名/包名/ 目录
• 用文本编辑器或命令行工具打开 README.md
• 例如：cat vendor/guzzlehttp/guzzle/README.md

大多数主流包都会把使用说明写在 README 中，这是标准做法。

3. 在浏览器中查看（推荐）

• 大多数包的 composer.json 包含 homepage 或 support 字段
• 运行 composer show 包名 查看详情
• 例如：composer show monolog/monolog
• 输出中会包含 repository 和 homepage 链接，点开就能看到在线版 README

4. 使用第三方插件（实验性）

基本上就这些实用方法。Composer 的设计重点是依赖管理，展示文档不是它的职责。最好的习惯是安装后花一分钟看看包的 README，无论是本地文件还是项目仓库页面。

以上就是如何让composer在安装一个包时显示其README文件的详细内容，更多请关注php中文网其它相关文章！