0

0

如何通过Composer命令行快速查看包的README文档?(本地查阅)

穿越時空

穿越時空

发布时间:2026-03-16 16:30:03

|

301人浏览过

|

来源于php中文网

原创

composer show 命令不支持直接打开 README,仅显示包元信息;README 通常位于 vendor/vendor-name/package-name/ 下,文件名常见为 README.md、README 或 readme.md,需手动定位后用 open、xdg-open 或 Invoke-Item 打开。

如何通过composer命令行快速查看包的readme文档?(本地查阅)

composer show 命令本身不支持直接打开 README

它只显示包的元信息(版本、描述、依赖等),composer show vendor/package 输出里根本没有 README 路径或内容。想本地看文档,得自己定位文件再用终端命令打开。

README 通常在 vendor/ 目录下对应包的根目录

Composer 安装后,每个包都解压到 vendor/vendor-name/package-name/,而 README 文件名常见为 README.mdREADMEreadme.md(大小写敏感,Linux/macOS 下尤其要注意)。

  • 先确认包是否已安装:composer show vendor/package —— 如果报错“Package not found”,说明没装或拼写错了
  • 进 vendor 目录手动查:ls -F vendor/vendor-name/package-name/ | grep -i readme
  • 常见路径示例:vendor/guzzlehttp/guzzle/README.mdvendor/laravel/framework/README.md
  • Windows 用户注意:CMD 不识别 open,改用 start;WSL 用户需确保已配置好 GUI 支持

一行命令快速打开 README(macOS/Linux)

把路径拼出来 + openxdg-open 就行,不用记完整路径:

open "$(composer show -s vendor/package | head -n1 | sed 's/.*at //')/README.md"

但这个命令有坑:

米粿AI
米粿AI

AI辅助动漫创作工具,专为专业漫画师和动画制作团队设计

下载
  • composer show -s 输出的是源码路径(即 vendor/xxx),但不是所有包都带 -s 选项支持——Composer 2.5+ 才稳定返回,旧版可能为空
  • 如果 README 是 readmeREADME(无后缀),上面命令会失败
  • 更稳妥的做法是写个 shell 函数,比如加到 ~/.zshrc
alias c-readme='function _c_readme() { local p=$(echo $1 | sed "s|/|\/|g"); cd vendor/$p && ls -1 README* readme* 2>/dev/null | head -n1 | xargs -r open; }; _c_readme'

然后运行:c-readme guzzlehttp/guzzle

Windows PowerShell 快速方案

PowerShell 没有内置 open,但可以用 Invoke-Item(等效于双击):

  • 先跳转:cd vendor\vendor-name\package-name
  • 再打开:Invoke-Item (Get-ChildItem README*,readme* | Select-Object -First 1)
  • 或者合并成一行:cd vendor\vendor-name\package-name; Invoke-Item (ls README*,readme* | select -f 1)
  • 注意反斜杠路径和大小写——PowerShell 在 Windows 上对大小写不敏感,但 WSL 或 Git Bash 下仍要小心

真正麻烦的不是命令本身,而是 README 文件名没有统一规范,加上 vendor 目录权限、符号链接、软链包(如 composer link)这些情况,会导致路径解析失败。最省事的方式其实是:装个 IDE(如 PHPStorm),右键包名 → “Open in Explorer”,再点 README —— 比记命令可靠得多。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

341

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

295

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

795

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

386

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

146

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

85

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

84

2025.08.05

PHP高性能API设计与Laravel服务架构实践
PHP高性能API设计与Laravel服务架构实践

本专题围绕 PHP 在现代 Web 后端开发中的高性能实践展开,重点讲解基于 Laravel 框架构建可扩展 API 服务的核心方法。内容涵盖路由与中间件机制、服务容器与依赖注入、接口版本管理、缓存策略设计以及队列异步处理方案。同时结合高并发场景,深入分析性能瓶颈定位与优化思路,帮助开发者构建稳定、高效、易维护的 PHP 后端服务体系。

752

2026.03.04

chatgpt使用指南
chatgpt使用指南

本专题整合了chatgpt使用教程、新手使用说明等等相关内容,阅读专题下面的文章了解更多详细内容。

0

2026.03.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二十四期_PHP8编程
第二十四期_PHP8编程

共86课时 | 3.5万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 2.6万人学习

第二十三期_PHP编程
第二十三期_PHP编程

共93课时 | 7.6万人学习

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

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