如需下载,请在电脑端打开本页操作。
README.md

面向 AI 编程助手的 SwiftData Agent 技能

一款帮助 Claude Code、Codex、Cursor、Gemini 等 AI 编程助手写出更优质 SwiftData 代码的 agent 技能。覆盖 @Model@Query、谓词(predicates)、索引、迁移、关系、iCloud 同步等内容,专门针对 LLM 实际容易出错的地方。

同系列还有:

Swift Agent Skills可以找到更多面向 Swift 和 Apple 平台开发的 agent 技能。

安装 SwiftData Pro

你可以通过 npx 将此技能安装到 Claude Code、Codex、Gemini、Cursor 等工具中:

npx skills add https://github.com/twostraws/swiftdata-agent-skill --skill swiftdata-pro

如果报错 npx: command not found,说明你还没有安装 Node。需要先通过 Homebrew 安装 Node:

brew install node

如果连这条命令都失败了,通常意味着你需要先安装 Homebrew(英文)。

使用 npx 安装时,你可以精确选择要在哪些 agent 中使用此技能,也可以选择是仅为当前项目安装,还是对所有项目可用。

另外,你也可以克隆整个仓库,然后按自己喜欢的方式安装。

如果你使用的是 Xcode,可以观看 YouTube 视频 如何在 Xcode 中安装和使用 Agent 技能(英文)了解安装步骤。

使用 SwiftData Pro

这款技能名为 SwiftData Pro,可以通过多种方式触发。例如,在 Claude Code 中这样使用:

/swiftdata-pro

在 Codex 中则这样使用:

$swiftdata-pro

两种方式下,如果你只想做局部检查,都可以附带具体指令。例如,在 Claude 中输入 /swiftdata-pro 检查我的代码是否使用了最新 API,或在 Codex 中输入 $swiftdata-pro 检查我的 SwiftData 模型应该在哪里添加索引

你也可以用自然语言触发技能:

使用 SwiftData Pro 技能为这个项目启用 iCloud 支持。

为什么要用 SwiftData Agent 技能?

我写过一本关于 SwiftData 的书(英文),并且会随着新功能的加入定期更新,所以吃透 SwiftData 的方方面面可以说是我的本职工作。

这款技能就是这些积累的成果。其中的规则直接针对 LLM 常犯的 SwiftData 错误,涵盖它们没被训练过的新特性、它们频繁出错的旧特性,以及帮助你保持代码正确且高效的编程模式。

不是把所有 SwiftData 建议一股脑塞进来。Agent 对 SwiftData 基础已经有扎实的掌握,那些只是把它们已知的东西再教一遍的技能纯粹是在浪费 token。

这款技能聚焦于真正能产生影响的内容。

贡献

欢迎所有形式的贡献——无论是添加新的检查项、改进已有检查,还是修改这份 README——所有人都可以参与!

  • 保持 Markdown 简洁。使用技能是有 token 成本的,尤其是 SKILL.md,所以请尊重用户的 token 预算。
  • 不要重复 LLM 已经知道的东西,那只会白白消耗 token。聚焦于边界情况、意外行为、软性弃用(soft deprecations)以及类似内容。
  • 所有代码必须采用 MIT 许可证,以便让更多人受益。

请确保遵守 行为准则

许可证

SwiftData Pro 最初由 Paul Hudson 创作,他在 Hacking with Swift(英文)上撰写免费 Swift 教程。本项目基于 MIT 许可证 发布,允许商业使用、修改、分发和私人使用。