ARTICLE DETAIL

资讯详情

深耕郑州网站建设与运营推广的一线实战洞察。

open-saas 如何配置 AGENTS.md 与 Agent Skills 以使用 AI 编码工具开发

open-saas 如何配置 AGENTS.md 与 Agent Skills 以使用 AI 编码工具开发 open-saas 如何配置 AGENTS.md 与 Agent Skills 以使用 AI 编码工具开发【免费下载链接】open-saasA 100% free modern JS SaaS boilerplate (React, NodeJS, Prisma). Full-featured: Auth (email, google, github, slack, MS), Email sending, Background jobs, Landing page, Payments (Stripe, Polar.sh), Shadcn UI, S3 file upload. AI-ready with tailored AGENTS.md, skills, and Claude Code plugin. One cmd deploy. Powered by Wasp full-stack framework.项目地址: https://gitcode.com/GitHub_Trending/op/open-saas用 AI 编码工具Claude Code、Cursor、VS Code/Copilot、Codex、Gemini CLI、OpenCode 等基于 open-saas 模板开发时agent 对项目结构和 Wasp 框架的工作方式并不熟悉容易凭空猜测。Open SaaS 模板在app目录中预置了AGENTS.md规则和 3 个 Agent Skills 来解决这个问题。这篇文章说明这些文件的位置与内容、如何让编码工具加载它们并用真实命令验证配置生效。适用对象是已经或准备用wasp new创建 Open SaaS 应用的开发者。模板里预置了哪些 AI 配置文件按 Getting Started 指南 在目标目录执行wasp new、在模板列表中选择saas即可克隆一份干净的 Open SaaS 模板。项目包含三个目录appWasp 应用、e2e-testsPlaywright 测试、blogAstro/Starlight 文档站见 模板 README。AI 配置全部在app目录内vibe-coding 指南将其分为两类规则文件AGENTS.md是许多 AI 编码工具通用的开放标准文件用于在编码时向 agent 下达指令CLAUDE.md是指向AGENTS.md的符号链接两者内容始终一致。文件本体见 AGENTS.md。Skills 目录app/.agents/skills/存放遵循 Agent Skills 标准的技能app/.claude/skills/下的条目是符号链接指向同一批技能文件供 Claude Code 加载。预置了 3 个技能技能文件作用可直接调用getting-startedSKILL.md抓取文档、检查 Wasp 安装、协助启动数据库和应用是guided-tourSKILL.md逐节带用户了解项目结构、功能与定制清单是add-wasp-skillsSKILL.md引导安装 Wasp 框架专属技能插件是三个技能在 frontmatter 中均为user_invocable: true即在支持 Agent Skills 的工具聊天中可以直接点名调用。AGENTS.md 规则的内容AGENTS.md 的核心是一条文档获取规则在接手任务、回答问题或做任何开发工作之前agent 必须先抓取并对照 Open SaaS 文档验证自己的知识从https://docs.opensaas.sh/llms.txt获取 Open SaaS 文档地图其中包含所有文档章节的 raw markdown 文件 URL从中找到与当前任务相关的指南直接从这些 raw.githubusercontent.com URL 抓取内容——文档明确要求不要使用 HTML 页面 URL。另有一条兜底规则模板构建在 Wasp 框架之上如果 Open SaaS 文档对某个功能信息不足则去查 Wasp 文档的https://wasp.sh/llms.txt索引。这条机制的意义在于即使 agent 的训练数据滞后它也会在每次任务时在线拉取最新文档而不是凭记忆作答。让 AI 编码工具加载这些 Skills用支持 Agent Skills 标准的编码工具打开项目时要指向包含AGENTS.md和.agents/skills/的目录即app目录或包含它的项目根目录。加载行为按 vibe-coding 指南 的说明技能已放在app/.agents以及app/.claude目录中通常会由工具自动加载如果你的工具没有自动加载Open SaaS 文档将具体配置步骤交给该工具自己的文档——去查所用工具关于添加 Agent Skills 的说明而不是猜测app/.claude/skills/下三个条目均为指向app/.agents/skills/对应目录的符号链接所以只需维护.agents下的内容两个路径读到的文件是同一份。验证配置生效最直接的路径是运行getting-started技能。它的流程见 SKILL.md是agent 先从 llms.txt 索引抓取文档地图再抓取 Getting Started 指南全文作为唯一事实来源然后执行wasp version检查 Wasp 是否安装已安装则向用户确认版本号并继续未安装则按指南中对应操作系统的安装说明引导安装安装后再次用wasp version验证最后询问用户是否协助启动托管的 PostgreSQL 数据库和 Wasp 应用。这条流程能走通说明 AGENTS.md 的规则抓文档地图和技能都已被 agent 正确执行。该技能最终引导的启动步骤与成功判定来自 Getting Started 指南前置条件和命令如下环境要求Node.js含 NPM在PATH中可用版本必须 24.14.1可用node -v检查Windows 需先装 WSL2文档推荐 Ubuntu。安装 Wasp CLILinux/macOSWindows 下在 WSL2 内执行npm i -g wasp.sh/wasp-cli安装后用wasp version验证。启动数据库确认 Docker 已安装并在运行然后在app目录执行wasp start db该终端需要保持打开进程终止后数据库即对应用不可用。创建首次迁移另开一个终端wasp db migrate-dev首次运行较慢因为要安装 Wasp 项目的全部依赖。之后每次修改 Prisma schema 后都要再执行它。启动应用回到app目录cp .env.server.example .env.server wasp start.env.server存放支付、邮件等服务的 API key文档说明保留示例中的 dummy key 即可跑通应用。成功判定浏览器自动打开应用或手动访问http://localhost:3000。此时数据库通常运行在 5432 端口服务端在 3001 端口。guided-tour技能验证另一个维度agent 抓取 Guided Tour 文档后逐节讲解项目结构指出与每节相关的文件与代码并在每个主要章节后暂停提问。如果 agent 能准确定位到项目里的真实文件和代码说明规则与技能都已生效。可选安装 Wasp 框架专属 Skillsvibe-coding 指南 建议运行add-wasp-skills技能为项目追加 Wasp 框架专属技能以获得在 Wasp/Open SaaS 上更好的编码效果。该技能SKILL.md自身不含安装命令其流程是告知用户 Wasp agent skills又称插件可用从 Wasp 官方 wasp-agent-plugins 仓库 wasp 插件的 READMEraw URL 写在该 SKILL.md 内抓取安装说明再按抓到的 README 逐步引导安装。执行该技能前先打开上述 SKILL.md 确认目标 README 的 URL。备用手动粘贴 LLM 文档链接如果 agent 没有主动抓取文档或你想在普通聊天会话中提供背景可以把 LLM 友好的文档链接直接粘贴给 agent。vibe-coding 指南列出了 4 个https://docs.opensaas.sh/llms.txt—— Open SaaS 文档各章节的 raw text 链接https://docs.opensaas.sh/llms-full.txt—— 完整文档合并为单个文本文件https://wasp.sh/llms.txt—— 按 Wasp 版本组织的 raw text 链接https://wasp.sh/llms-full.txt—— 完整 Wasp 文档合并为单个文本文件AGENTS.md 中已内置自动抓取这两个索引的规则手动粘贴只是兜底手段。限制与说明文档将预置的 skills 和 rules 定位为起点先靠它们把项目跑起来之后按需要扩展不要把它们当作完整的生产方案。Open SaaS 文档没有为每个编码工具编写单独的加载配置不自动加载技能的场景以工具自身文档为准。Windows 用户还有一条边界Wasp 项目应放在 WSL2 的 Linux 文件系统上而不是 Windows 文件系统否则 Wasp 无法检测到文件变更。【免费下载链接】open-saasA 100% free modern JS SaaS boilerplate (React, NodeJS, Prisma). Full-featured: Auth (email, google, github, slack, MS), Email sending, Background jobs, Landing page, Payments (Stripe, Polar.sh), Shadcn UI, S3 file upload. AI-ready with tailored AGENTS.md, skills, and Claude Code plugin. One cmd deploy. Powered by Wasp full-stack framework.项目地址: https://gitcode.com/GitHub_Trending/op/open-saas创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表