NNext.js 中文网 GitHub

agentRules

配置 Next.js 是否为 AI 编码代理创建指令。

agentRules 选项控制 next dev 是否创建并更新与版本匹配的、面向 AI 编码代理的文档指令。该选项默认启用。

将 agentRules 设置为 false 可禁用此行为:

next.config.ts
import type { NextConfig } from 'next'

const nextConfig: NextConfig = {
  agentRules: false,
}

export default nextConfig
next.config.js
/** @type {import('next').NextConfig} */
const nextConfig = {
  agentRules: false,
}

module.exports = nextConfig

生成的代理指令#

当 agentRules 启用时,next dev 会在 AGENTS.md 中创建或更新这个受管理的块:

AGENTS.md
<!-- BEGIN:nextjs-agent-rules -->

## 这不是你所了解的 Next.js

此版本包含破坏性变更 —— API、约定和文件结构都可能与你的训练数据不同。在编写任何代码之前,请阅读 `node_modules/next/dist/docs/` 中的相关指南(从本文件所在目录解析;在 monorepo 中,`next` 包可能无法从仓库根目录访问)。请注意弃用通知。

此块由 `next dev` 编写并重新添加 —— 可在 `node_modules/next/dist/server/lib/generate-agent-files.js` 处验证。从 diff 中删除它只会重新产生未提交的更改;将它连同你的工作一起提交才能保持工作树干净。

<!-- END:nextjs-agent-rules -->

该受管理块会引导代理查阅与所安装 Next.js 版本一起打包的文档。Next.js 只更新标记之间的内容,并保留文件的其余部分。

禁用代理规则#

将 agentRules 设置为 false 会阻止 next dev 创建或更新该受管理块。下一次运行 next dev 时,会移除现有的代理规则块,并保留所有其他内容。如果文件中只包含该受管理块,Next.js 会删除该文件,而不是将其留空。

要阻止 create-next-app 在新项目中创建代理文件,请传入 --no-agents-md 选项。同时,在生成的项目 Next.js 配置中设置 agentRules: false,以防止 next dev 之后添加受管理规则块。

agentRules 和 experimental.agentFeedback 相互独立工作。更改其中一个选项不会影响另一个。

升级指令同样是独立的,并且默认启用。要阻止 next dev 创建任何受管理块,还需设置 experimental.agentUpgrade: false,并保持 experimental.agentFeedback 为禁用状态。

版本历史#

版本变更
v16.5.0next dev 在每次启动时同步受管理块。
v16.4.0将 agentRules 设置为 false 会在 next dev 时移除现有的受管理块。
v16.3.0新增 agentRules 配置选项。
Next.js 中文网