AB
AiBoss站
project

floorplan - 让 Claude Code 或 Codex 为你的代码库画一张可交互地图

floorplan 是一个运行在 Claude Code 与 Codex 中的插件:它读取你的代码库,把各个部分、文件和网络请求用平实的语言命名,并画出它们之间的连接,生成一张可在浏览器中缩放浏览的交互地图。项目采用 MIT 许可证,截至 2026-11-19 星标数为 4927。

floorplan 是一个面向 AI 辅助开发者的代码库可视化工具。按项目自述,它由 Claude Code 或 Codex 读取你的代码库,把每个部分、每个文件和每个网络请求都用平实的英文命名,并画出它们之间的连接,最终生成一张可以在浏览器里缩放、点击、提问的交互地图。它想解决的问题很具体:应用能跑起来,但被问到「用户结账时到底发生了什么」「改这里会影响什么」时,开发者往往答不上来。floorplan 给出的就是那张「没人画过的图」。据项目说明,它适合三类人:用 AI 搭建应用但不读代码的开发者、需要快速带新人了解系统的团队,以及希望在每次 AI 改动后看清「动了哪些部分、为什么动」的人。

维护者与状态

仓库由 haydenschmitty 维护,地址为 haydenschmitty/floorplan。仓库创建于 2026-10-27,最后一次提交在 2026-11-16。最新正式版本为 floorplan--v0.11.0,发布于 2026-11-18。截至 2026-11-19,仓库星标数为 4927。项目另有一个在线演示站点,可直接在浏览器中查看示例地图,无需安装。

主要能力

以下能力均据项目自述整理,未经本站实际运行验证。

  • 多层级地图:从整个应用开始,双击进入某个部分、一组文件、单个文件及其端点;每个视图都会显示它被谁使用、又依赖了谁。
  • 平实语言命名:用「在结账时收取银行卡付款」这类描述代替「Stripe API wrapper」式的技术术语,悬停可看解释,另有开关切换到开发者视图。
  • 跨仓库的真实连接:跟随 import 关系,并把前端的每个网络请求匹配到响应它的服务端端点,即使前后端位于不同仓库。
  • 从页面出发:选定一个你熟悉的页面,查看它背后的一切——涉及的部分、发出的请求、服务端代码、数据以及外部服务。
  • 向地图提问:例如「退款怎么回到用户卡上」,返回一段回答,加上只包含相关部分的迷你地图和分步说明。
  • 健康检查:项目自述可发现 AI 生成应用中常见的问题,如密钥写在代码里或被发到浏览器、Supabase 表任何人可读、Firebase 规则开放、Stripe webhook 可被伪造、端点没有登录校验,并为每项给出可直接粘贴的修复方案。项目明确说明这是「检查,不是审计」。
  • 最近改动:AI 刚改过的卡片会以绿色高亮,并附注该改动如何服务于你的需求。
  • 保持更新:更新时只重新读取发生变化的部分,已打开的地图会自动刷新;所有内容都在本机运行,不提交到 git。
  • 其他:可用自然语言请求生成引导式流程、一分钟入门导览、导出为单个 HTML 文件分享、手机与平板布局(支持拖拽与双指缩放)、搜索、键盘快捷键,以及每张卡片上的右键操作。
  • 蓝图模式:除已有代码外,也可从 PRD、规格文档或描述出发,画出尚未构建的应用的「蓝图」,卡片以虚线标示这是计划;此时健康检查会换成「计划还留有哪些未决问题」的评审,并可从地图上继续调整计划。

使用入口

仓库地址:haydenschmitty/floorplan。在线演示:floorplan-demo。

据项目说明,运行需要 Node.js 18+,以及 Claude Code 或 Codex 之一;它使用你已有的订阅计划,不需要 API key。在 Claude Code 中安装:

claude plugin marketplace add haydenschmitty/floorplan
claude plugin install floorplan@floorplan

在 Codex 中,可在应用的 Plugins 里添加市场并填入 haydenschmitty/floorplan,或使用终端:

codex plugin marketplace add haydenschmitty/floorplan
codex plugin add floorplan@floorplan

安装后新开一个会话,在项目中提出「Make me a floorplan of this app」即可;在 Codex 中也可以输入 $floorplan。若前后端分处不同仓库,项目建议打开同时包含两者的上级目录。后续改动后可再要求「Update the floorplan」,只重新读取变化的部分。

许可与限制

项目采用 MIT 许可证。使用前需注意的前置条件与边界:必须安装 Node.js 18+,并依赖 Claude Code 或 Codex 作为运行环境,二者缺一不可;地图的提问栏依赖你本机的 Claude Code CLI 或 Codex 登录状态。项目自述健康检查是「检查,不是审计」,不应把它当作完整的安全审计结论。蓝图模式针对的是尚未构建的应用,其输出是计划而非对真实代码的映射。此外,项目自述所有处理都在本机完成、不写入 git,但具体行为仍建议以仓库文档为准。