Skip to content

📖 实例教程

本节的每个文档都对应 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_configurationcomposer.json 操作、配置、认证、仓库管理进阶
🌍 cli_global全局安装、更新、移除包进阶
🧩 cli_advancedSatis 私有仓库、命令执行、版本约束、诊断、归档、环境变量高级

如何运行

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 的 自动安装能力

学习路径

建议按以下顺序学习:

  1. basic_setup → 理解客户端初始化
  2. get_statistics / list_packages → 熟悉常见查询
  3. security_advisories → 接触安全场景
  4. cli_basic_usage → 转入本地 Composer 操作
  5. cli_package_management → 掌握依赖管理
  6. security_monitor / cli_advanced → 综合实战

每个示例都标注了对应的 SDK 方法链接,方便深入查阅 API 参考。

基于 MIT 许可证发布