📖 实例教程
本节的每个文档都对应 examples/ 下的一个可运行示例,带完整代码与逐行讲解。跟着做一遍,胜过读十遍 API 表。
Packagist API 示例(远程操作,无需 PHP)
| 示例 | 演示内容 | 难度 |
|---|---|---|
| 🚀 basic_setup | 初始化 Packagist API 客户端 | 入门 |
| 📥 download_index | 下载完整包索引 | 入门 |
| 📋 list_packages | 获取并处理包列表 | 入门 |
| 📊 get_statistics | 获取仓库统计信息 | 入门 |
| 🔒 security_advisories | 获取安全漏洞公告 | 进阶 |
| ⭐ popular_packages | 获取最受欢迎的包 | 入门 |
| 🛡️ security_monitor | 构建安全监控系统 | 高级 |
Composer CLI 示例(本地操作,需要 PHP+Composer)
| 示例 | 演示内容 | 难度 |
|---|---|---|
| 🚀 auto-install | 自动安装 Composer + PHP(跨平台) | 入门 |
| ⌨️ cli_basic_usage | 创建 Composer 实例、执行基本命令 | 入门 |
| 📦 cli_package_management | 安装、更新、添加、移除、搜索包 | 进阶 |
| 🏗️ cli_project_management | 创建项目、运行脚本、平台检查、依赖分析 | 进阶 |
| 🔐 cli_security | 安全审计、平台要求检查、配置验证 | 进阶 |
| 🔍 cli_inspection | 包信息、依赖树、why 分析、资金与许可证 | 进阶 |
| ⚙️ cli_configuration | composer.json 操作、配置、认证、仓库管理 | 进阶 |
| 🌍 cli_global | 全局安装、更新、移除包 | 进阶 |
| 🧩 cli_advanced | Satis 私有仓库、命令执行、版本约束、诊断、归档、环境变量 | 高级 |
如何运行
bash
# 克隆仓库
git clone https://github.com/scagogogo/composer-skills.git
cd composer-skills
# 运行某个示例(以 security_monitor 为例)
go run examples/security_monitor/main.go远程示例无需任何环境
Packagist API 类示例(basic_setup、get_statistics 等)是纯 Go,不需要 PHP 或 Composer,clone 下来直接 go run 即可。
本地 CLI 示例需要 PHP
cli_* 系列示例执行本地 composer 二进制,需要本机已安装 PHP 7.4+ 与 Composer 2.0+。若未安装,可借助 SDK 的 自动安装能力。
学习路径
建议按以下顺序学习:
- basic_setup → 理解客户端初始化
- get_statistics / list_packages → 熟悉常见查询
- security_advisories → 接触安全场景
- cli_basic_usage → 转入本地 Composer 操作
- cli_package_management → 掌握依赖管理
- security_monitor / cli_advanced → 综合实战
每个示例都标注了对应的 SDK 方法链接,方便深入查阅 API 参考。