Floorplan
Floorplan 是 Claude Code 和 Codex 插件,可读取代码库并生成交互式、通俗易懂的应用地图。其在线演示绘制了 Brewline——一个包含在线商店、员工应用、主服务器、后台任务和外部服务的示例咖啡店应用。
访问 haydenschmitty/floorplan项目简介
Floorplan 是一款 Claude Code 和 Codex 插件,可读取代码库并绘制交互式地图。每个部分、文件和网络请求都有通俗易懂的名称,彼此之间的连接也会显示出来。在线演示绘制的是 Brewline,一个示例咖啡店应用;插件则用于你自己的项目。
核心功能
- 可在每个层级缩放查看:从整个应用开始,再深入部分、文件组、文件与端点,并查看它们使用什么以及被什么使用。
- 全程使用通俗易懂的标签与说明,并可切换到开发者视图查看技术术语。
- 跨仓库匹配真实连接:跟随导入关系,并将前端网络请求匹配到响应它的服务器端点。
- 从页面开始探索:选择页面即可查看其组成部分、发出的请求、背后的服务器代码、数据与外部服务。
- 向地图提问:问题会返回答案,以及仅包含相关部分的迷你地图和分步说明。
- 健康检查与最近工作:标记常见安全与配置问题,并高亮 AI 刚刚更改的内容及原因。
适用场景
- 在不阅读全部代码的情况下理解你用 AI 构建的应用。
- 让团队成员从整体图景快速了解直到具体文件和端点。
- 在每次更新后查看 AI 改动触及了哪些部分以及原因。
- 根据 PRD 或规格说明,将尚未构建的应用规划为蓝图。
快速开始
- 安装 Claude Code 插件:claude plugin marketplace add haydenschmitty/floorplan,然后运行 claude plugin install floorplan@floorplan。在 Codex 中,添加市场 haydenschmitty/floorplan 并安装 floorplan@floorplan,或运行 codex plugin marketplace add haydenschmitty/floorplan。
部署与要求
- 需要 Node.js 18+,以及 Claude Code 或 Codex。Floorplan 使用你已有的套餐运行,无需 API 密钥。扫描、地图和小型本地服务器都在你的计算机上运行。
采用前须知
- 许可证:MIT。在使用、修改或分发项目前,请确认其具体条款。