Communitygithub.com

项目设置

完成通过 create-agent-ready-app 创建的项目,在现有仓库中集成该工具包,或添加/移除附加组件。适用于开始新项目或添加 API、数据库、登录、邮件或 UI 库时使用。

项目设置 是什么?

该技能(名为“项目设置”)旨在帮助开发者使用 `create-agent-ready-app` 工具包管理项目的初始设置和持续配置。它支持三种主要场景:为新创建的项目进行后续配置(如设置数据库、同步文档、填充 PROJECT.md);将工具包集成到现有项目中,避免大规模重构;在项目后期安全地添加或移除附加组件(如 TanStack Query、shadcn、认证等)。该技能优先使用官方 CLI 和文档,并包含保护机制(如要求确认后再执行远程操作或重大更改)。它兼容多种平台,包括 Next.js、TanStack Start、Cloudflare 等,并集成了 `official-docs`、`find-skills` 等辅助技能,用于在整个开发工作流中维护工具包与规则。

兼容平台✓Claude Code~Codex CLI✓Cursor
npx skills add https://github.com/ahtserhsuddav/create-agent-ready-app/tree/main/template/agent/.agents/skills/project-setup

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

项目设置 是做什么的?

每一步都使用所涉及工具的官方 CLI 或文档(技能 official-docs)。在涉及任何远程操作前先询问。

刚刚创建(CLI 已完成脚手架搭建、安装和检查)

  1. 阅读 PROJECT.md,并用人类的语言填写什么(名称、领域、类型、用途)。 {{#dotenv}}
  2. 用户将 .env.example 复制为 .env 并填写{{#auth}}({{dlx}} auth@latest secret 生成认证密钥){{/auth}}。 Agent 绝不创建、读取或写入 .env。在它存在之前,使用仅用于该命令的临时测试值。 {{/dotenv}} {{#postgres}}
  3. 本地数据库:docker compose up -d,然后 {{run}} db:migrate(先询问)。 {{/postgres}} {{#d1}}
  4. 本地数据库:{{run}} db:migrate(先询问)。 {{/d1}}
  5. {{run}} docs:sync,然后填写 docs/DEPLOYMENT.md(URL、密钥设置位置)。 {{#cloudflare}} 在 wrangler.jsonc 中替换占位符 ID(一旦资源创建完成,见 DEPLOYMENT.md → 首次设置)。 {{/cloudflare}}
  6. 将 design/DESIGN.md 留给 website-design 技能,该技能会在第一个页面之前按顺序收集设计输入;首页是一个占位符。
  7. 一旦仓库上线至 GitHub,用户开启 Settings → Actions → General → "Allow GitHub Actions to create and approve pull requests",以便每周的 agent-skills 更新可以打开其 PR。Dependabot 和工作流变更:参见技能 dependabot 和 github-actions-hardening。
  8. {{run}} log "项目已设置" --by <agent>。

现有项目(采用工具包)

  1. {{dlx}} create-agent-ready-app@latest install . 仅添加 Agent 设置(AGENTS.md、技能、脚本、防护措施);它会从 package.json 中检测附加组件。旧的 AGENTS.md、CLAUDE.md、.cursorrules 及类似文件移至 docs/legacy-agents.md:将仍然适用的规则合并到 PROJECT.md → Agent 规则中,然后删除它(先询问)。
  2. 根据现有内容(package.json、路由、快速文件夹列表)填写 PROJECT.md。不要深入探索。
  3. 不要重构。将差距(结构、检查、SEO、安全性)列为一个提议的大任务并询问。

稍后添加附加组件(受保护)

  1. 询问一个是否问题:附加组件、它将添加的包、它将创建的文件。
  2. {{dlx}} create-agent-ready-app@latest add <附加组件> . 创建该组件尚不存在的文件,刷新 AGENTS.md 和技能,安装其技能包,并打印需要添加的包。
  3. {{add}} 那些包。然后将其接入项目已有的文件中,遵循该组件在 create-agent-ready-app 仓库(template/frameworks/)中的文件以及官方文档:
    • query:{{#tanstack-start}}src/router.tsx(QueryClient + SSR 集成)和 src/routes/__root.tsx(devtools 面板){{/tanstack-start}}{{#next}}src/shared/lib/tanstack/query-provider.tsx 位于 src/app/layout.tsx{{/next}};
    • shadcn:{{dlx}} shadcn@latest apply --preset nova,然后 add 你需要的组件;
    • auth:位于 {{#tanstack-start}}src/routes/_private/{{/tanstack-start}}{{#next}}src/app/(private)/{{/next}} 下的守卫以及 {{run}} auth:generate,然后 {{run}} db:generate。
  4. {{run}} docs:sync、{{run}} check、更新 PROJECT.md → 栈与决策,并添加一条日志。

移除附加组件(受保护)

{{dlx}} create-agent-ready-app@latest remove <附加组件> . 移除其工具包文件、技能、脚本和权限。 删除其代码和包是一项大任务:使用 rg 搜索每个使用处,删除它,然后 {{run}} check。

Agent 技能

  • .agents/skills/ 中的社区技能来自其制作者(skills-lock.json 记录每个来源和哈希值)。{{run}} skills:update 刷新它们;在提交前阅读差异,就像对待任何代码变更一样。
  • 更多技能:优先使用工具制作者的官方技能(https://www.skills.sh/official);技能 find-skills,或 {{dlx}} skills@latest add <owner/repo> --skill <名称> -a universal -a claude-code(先询问)。可选的工具包包:{{dlx}} create-agent-ready-app@latest add <包名> .(营销、安全审查……)。

更新工具包

{{run}} kit:update 刷新 AGENTS.md、技能和脚本。该项目中变更过的工具包文件会被保留并报告;项目特定的规则应放在 PROJECT.md 中,而不是编辑工具包文件。

Individual skills in this repo

This repo contains 1 individual skill — each has its own dedicated page.

相关技能