article
README
🚀 Xcode-MCP 工具文档
Xcode-MCP 是一款功能强大的命令行工具,可简化 macOS 和 iOS 应用程序的开发、测试与分发流程。它整合了各类 Xcode 工具和现代设备控制功能,能有效提升开发者的工作效率。
🚀 快速开始
核心工具
- xcode-list-schemes:列出项目中的所有可用方案。
- xcode-test:执行测试并生成结果报告。
- xcode-archive:创建可用于分发的 IPA 包。
- xcode-clean:清除构建缓存和临时文件。
- xcode-run-simulator:在指定的 iOS 模拟器上运行应用程序。
- xcode-run-device:在连接的真机设备上运行应用程序。
示例用法
🔍 测试流程
- 列出项目中的所有方案:
xcode-list-schemes --project /Users/username/Projects/MyApp.xcodeproj
- 选择一个方案并执行测试:
xcode-test --project /Users/username/Projects/MyApp.xcodeproj --scheme MyApp --configuration Debug
- 打包应用进行分发:
xcode-archive --project /Users/username/Projects/MyApp.xcodeproj --scheme MyApp --configuration Release --output /Users/username/Desktop/MyApp.ipa
使用LLM的示例工作流程
💬 用户提示给Claude
我需要检查我的Xcode项目,运行一些测试,然后打包进行分发。
1. 首先使用xcode-list-schemes工具列出我在/Users/username/Projects/MyApp.xcodeproj项目的所有方案。
2. 在看到方案后,请为第一个可用的方案在iPhone 14模拟器上运行测试。
3. 然后使用Release配置打包应用。
📋 预期工作流程
- Claude执行xcode-list-schemes工具获取所有方案:
Project path: /Users/username/Projects/MyApp.xcodeproj
- 选择第一个可用的方案并运行测试:
Project path: /Users/username/Projects/MyApp.xcodeproj
Scheme: MyApp
Destination: platform=iOS Simulator,name=iPhone 14
- 打包应用进行分发:
Project path: /Users/username/Projects/MyApp.xcodeprj
Scheme: MyApp
Configuration: Release
ArchivePath: /Users/username/Desktop/MyApp.ipa
⚠️ 安全注意事项
该工具可执行 Xcode 相关命令,存在一定安全风险。请留意以下几点:
- 仅用于可信项目:只在可信赖的 Xcode 项目中使用此工具。
- 未知来源需谨慎:对于来自不知名来源的项目保持警惕。
- 避免敏感信息:不在构建参数中包含敏感信息。
🛠️ 开发要求
系统需求
- Node.js 16 或更高版本
- npm 6 或更高版本
- Xcode 14 或更高版本(所有功能)
- Xcode 16 或更高版本(
devicectl和真机功能需要)
本地开发与测试
# 克隆仓库
git clone https://github.com/yourusername/xcode-mcp.git
cd xcode-mcp
# 安装依赖项
npm install
# 启动开发服务器
npm run dev
# 构建项目
npm run build
# 运行测试
npm test
提交代码
- 创建功能分支:
git checkout -b feature/new-feature
- 提交更改:
git add .
git commit -m "添加新功能"
- 推送到远程仓库:
git push origin feature/new-feature
- 创建 Pull Request。
📚 参考资料
通过遵循上述步骤,您可以高效使用 Xcode-MCP 工具管理开发流程。如需更多帮助,可随时查看问题跟踪页面或直接在 GitHub 上提交新问题。
感谢您选择 Xcode-MCP 工具!愿它为您的开发工作带来便利。
Scan to join WeChat group