BrassCoders 每次扫描后都会生成 .brass/ai_instructions.yaml 文件——纯净的 YAML,没有专有编码,也无需插件。Claude Code 会自动在项目目录中读取该文件。Cursor 和 Continue 用户可将其作为上下文文件引用。三种编辑器的格式一致:按严重程度排序的发现项,每项都包含文件路径、行号和修复说明。
一次扫描,一份文件,三种编辑器。
什么是 YAML-First 模式
BrassCoders 扫描 Python 代码库,运行 12 个静态分析扫描器,并将按严重程度排序的发现项写入 .brass/ai_instructions.yaml;该文件是纯文本,没有任何编码或专有结构,因此任何能读取本地文件的 AI 助手都可以将其作为上下文使用。
模式为:先扫描,再打开编辑器,将编辑器指向该文件,对扫描结果进行分类。AI 助手读取严重程度顺序、行号和修复说明——从确认而非发现开始工作。因为格式不依赖任何编辑器特定功能,所以适用于所有编辑器。它只是一个文件。编辑器读取文件。
Claude Code:自动项目上下文
BrassCoders 将 .brass/ai_instructions.yaml 写入项目目录,Claude Code 会自动将项目目录中的文件读取为上下文;无需额外配置即可将发现项呈现在模型面前。
运行 brasscoders --offline scan /path/to/project,然后在同一目录中打开 Claude Code。.brass/ai_instructions.yaml 文件将作为会话的项目上下文可用。要求 Claude Code 处理或分类这些发现,它会读取该文件,先识别关键严重级别的条目,并按严重程度顺序处理。
发现文件在会话之间持续存在。下次在同一目录中打开 Claude Code 时,除非已重新扫描并修复了标记的问题,否则该文件仍然存在。与聊天提示不同,关闭编辑器时发现不会重置。
Cursor:@file 引用
Cursor 支持 @file 引用,可将本地文件内容添加到聊天会话的 AI 上下文中;指向 .brass/ai_instructions.yaml 可为 Cursor AI 提供与 Claude Code 自动读取相同的按严重程度排序的发现队列。
在 Cursor 聊天会话中,输入 @file .brass/ai_instructions.yaml 以将发现作为上下文包含。Cursor AI 将该文件读取为结构化的发现列表,可以首先处理最高严重级别的发现,并携带可用于导航到标记位置的行号。这与 Claude Code 工作流相同——区别在于手动添加上下文引用,而不是由编辑器自动获取。
一个实用提示:在修复发现后打开新的 Cursor 会话前,重新运行 brasscoders --offline scan。.brass 文件不会自动更新。修复的发现会保留在文件中,直到重新运行扫描并覆盖它。
Continue:聊天中的上下文
Continue 在其聊天面板中支持 @file 引用,允许将任何本地文件作为问题的上下文包含;.brass/ai_instructions.yaml 的工作方式相同——在 Continue 聊天中输入 @file 并导航到发现文件。
对于 Continue 是 VS Code 中共享 AI 助手的团队来说,这使得 BrassCoders 发现可在会话中共享,而无需在每台机器上重新运行扫描。一个人运行 brasscoders --offline scan,将 .brass/ai_instructions.yaml 文件提交到分支,团队在他们的 Continue 会话中引用它。同一个分支上的所有人的发现都是一致的。
请查看 Continue 的文档,了解当前版本的 @file 语法,因为上下文提供程序行为在不同版本中已发生变化。
三种编辑器的一致性
无论由哪个编辑器使用,结构都是一样的:严重程度排序、行锚点、修复方向。BrassCoders 在写入文件前会将关键发现排在高严重级别发现之上,再排在中等严重级别发现之上。读取该文件的每个编辑器都会继承该优先级顺序。
行号字段在三种编辑器中的工作方式相同:AI 助手读取标记的行号,从该位置提取源上下文,并根据实际代码判断发现是否真实。文件路径字段的工作方式相同:它是项目根目录的相对路径,任何在项目目录中运行的工具都可以读取。
修复字段在三种编辑器中相同:这是一个在任何工具读取文件前写入的修复方向,基于扫描器匹配的模式。AI 助手读取修复说明、读取代码,然后生成修复或将发现作为误报而忽略。
一次扫描。一份文件。任何能读取文件的编辑器。
pip install brasscoders
brasscoders --offline scan /path/to/your/project
Enter fullscreen mode Exit fullscreen mode
0 Comments
Log in to join the conversation.No comments yet. Be the first to share your thoughts.