haydenschmitty/floorplan

开发工具

借助 Claude 或 Codex 把代码库变成可交互、通俗易懂的架构地图。

162
16
JavaScript
MIT
创建于 1 天前

Floorplan 是一个 Claude Code / Codex 插件,它读取代码库并生成一张交互式、用通俗语言描述的地图,覆盖应用的各个部分、文件和网络请求。它面向已经有一个能跑起来的应用(往往是 AI 生成的)、却难以回答“结账时发生了什么?”或“改这里会影响什么?”的开发者,也适合让新人快速上手的团队。

工作方式与机制

在 Claude Code 或 Codex 中打开项目(或包含多个仓库的父文件夹;前后端分仓时打开同时容纳两者的目录),然后让它生成 floorplan。普通 Node 脚本负责扫描文件、import、路由和请求,并在支持的框架中把前端请求匹配到后端端点;Claude 或 Codex 负责语义部分:给每个部分命名,并用通俗语言描述每个文件。输出是一个 floorplan/index.html 地图,在浏览器中打开并附带简短导览。要求“更新 floorplan”时只重读改动的部分,已打开的地图会自动刷新。像“用户下单后会发生什么?”这类问题也通过同一个 agent 回答,并返回只包含相关部分的迷你地图。地图还包含 Health check,用于发现写死在代码里的密钥和无需登录即可调用的端点,并标记最近改动的卡片。

多仓库的咖啡订阅示例应用提供了在线 demo,无需安装即可体验。同一插件在 Claude Code 和 Codex 中都能用,一边生成的地图另一边也能打开。

扫描、地图及其本地小服务都在你的机器上运行,服务只接受本机连接。提问通过你自己的 Claude Code CLI 或 Codex 账号,代码由 AI 按这些工具的常规方式读取。若改在 Claude 应用中打开地图,会先询问,再上传地图结构(不含源代码)。Floorplan 自身唯一可能发送的是候补名单邮箱,且只在注册后发送。

要求与限制

需要 Node.js 18+,以及 Claude Code 或 Codex;它使用你已有的订阅计划,无需 API key。安装通过任一工具的插件市场完成,Codex 可以不用终端安装。Ask bar 在 Claude 配合 CLI 时效果最好,因为能读取真实代码;Codex 桌面应用已自带所需组件,没有 Claude CLI 时也可以在 Claude 应用里仅凭地图提问。

小型应用首次生成地图需要几分钟,大型项目更久,因为每个文件和端点都要被描述,用量计入现有计划。文档列出的语言和框架覆盖较广但并非全部:明确支持 TypeScript、JavaScript、Python、Go、Rust、Java、Kotlin、Scala 以及 Vue、Svelte、Astro 文件,其他语言支持较浅。Floorplan 只写入自己的 floorplan/ 文件夹,在 Claude Code 中额外写一段到 CLAUDE.local.md;两者都不会提交,也不会修改你的代码或 .gitignore。仓库采用 MIT 许可(v0.2.0)。

HotRepo 点评

HotRepo 在 2026-10-28 的新项目榜记录到 162 个总 star、排名第 7,但没有可比的每日榜单历史;这是一个有日期的观察,不能说明热度上升或下降。

项目源码与说明

本文由 AI 根据项目 README 生成,更新于 2026年10月28日,以项目官方文档为准。