AGENTS.md 模板

通用 Agent

# AGENTS.md

## 环境约定

### 终端与网络

- 默认使用 `zsh` 执行终端命令
- 访问海外资源时，优先配合本地代理访问（参考 `~/.zshrc` 代理配置）

### Web 开发工具与技术栈

- Node.js 版本管理默认使用 `fnm`
- 包管理器默认使用 `pnpm`
- 编程语言默认使用 TypeScript
- 构建工具默认使用 Vite
- 前端框架默认使用 React
- 后端框架默认使用 NestJS
- JS 模块化默认采用 ESM

## 协作规范

- 涉及重要技术决策（如架构、框架、数据库、目录结构、第三方依赖等）时，先给出方案对比与推荐理由，等待用户确认后再执行
- 用户提出方案时，先评估其合理性；若有明显问题、风险或更优方案，先说明原因与取舍，再等待用户确认
- 新增第三方依赖前，先说明必要性、可选方案及推荐理由，经用户确认后再安装
- 不影响功能的优化（如重构、文档、测试、lint/format、类型修复等）可直接执行

## 执行以下操作前，必须先获得用户明确确认

- 删除文件、目录或执行不可恢复的数据删除操作
- 修改系统配置或开发环境配置（如 PATH、SSH、Git 全局配置等）
- 修改 Shell 配置文件（如 `.zshrc`、`.bashrc`、`.profile`）
- 删除数据库、数据文件或其他不可恢复的数据
- 重写 Git 历史（如 `git reset --hard`、`git rebase`、`git filter-repo` 等）
- 执行 Git force push（如 `git push --force`、`git push -f`）

Windows 终端与网络

### 终端与网络

- 默认使用 `powershell7` 执行终端命令
- 访问海外资源时，优先配合本地代理访问（参考 `~/.config/powershell/Microsoft.PowerShell_profile.ps1` 代理配置）

项目开发 Agent 模板

# AGENTS.md

## 项目概览

说明项目用途、核心业务、运行平台、部署形态和项目边界。

## 技术栈

说明主要语言、框架、运行时、数据库、构建工具，以及会影响开发方式的关键依赖。

## 项目环境

说明运行时和包管理器的版本要求，以及依赖安装、开发启动、构建、代码检查和测试命令。

## 项目结构

说明主要目录职责、模块划分、代码放置位置和架构分层关系。

## 常用命令

说明依赖安装、开发启动、构建、代码检查和测试命令。

## 项目约定

说明代码风格、命名规则、架构约束、代码复用原则，以及项目统一采用的开发工具和操作习惯。

## 测试要求

说明需要执行的检查和测试命令，以及哪些类型的改动需要新增或更新测试。

## 安全边界

说明密钥和敏感数据的处理要求、禁止执行的危险命令、权限限制、生产环境限制，以及不得随意修改的文件或目录。

React 项目

参考：VfanLee/react-admin-template

Vue 项目

参考：VfanLee/vue-admin-template