Repolode
haydenschmitty

haydenschmitty/floorplan

由 Claude Code 或 Codex 绘制的交互式代码库地图,用通俗语言展示各部分、文件、接口及其连接关系。

Star
3,062
Fork
233
未关闭 Issue
7
最近提交
5天前

这是什么?

Floorplan 是一个 Claude Code 和 Codex 插件,可以读取已有应用,生成可缩放、用通俗语言描述的应用地图。各个模块、文件和 Web 接口都会获得易懂的名称,文件之间的导入关系,以及前后端之间的请求,都会以连线标出,跨仓库的调用也能识别。

地图之外,还提供健康检查,能发现 AI 生成应用中常见的问题,例如代码中残留密钥、数据库表可被公开读取、Firebase 规则过于宽松、Stripe webhook 未验证、接口缺少登录校验,并给出修复建议。“最近改动”视图会高亮 AI 助手刚刚修改的部分。对于尚未开发的应用,也可以根据 PRD 或需求文档生成蓝图。

扫描与布局脚本基于纯 Node.js,无外部依赖,输出为只在本机访问的本地 HTML 文件。更新时只重新读取变化的文件,生成的文件夹不会被提交到 git。

核心功能

  • 01可缩放地图,从整个应用逐层深入到单个文件和接口
  • 02追踪导入关系,并跨仓库匹配前端请求与后端接口
  • 03健康检查:识别暴露的密钥、开放的数据库规则、未验证的 webhook 和未鉴权接口
  • 04“最近改动”视图高亮 AI 助手修改过的部分
  • 05蓝图模式可根据 PRD 或需求文档生成规划中的系统结构

适用场景

  • 在不通读全部代码的情况下,理解主要借助 AI 构建的应用
  • 为新成员介绍多仓库项目的整体结构
  • 回顾一次 AI 编码会话改动了什么以及原因
  • 发布前排查常见的安全配置问题

快速上手

  1. 1

    在 Claude Code 中添加 Floorplan 插件市场

    claude plugin marketplace add haydenschmitty/floorplan
  2. 2

    安装 Floorplan 插件

    claude plugin install floorplan@floorplan
  3. 3

    在新会话中让 Claude Code 为你的应用生成平面图

  4. 4

    打开浏览器中出现的地图并进行探索

使用前须知

  • 需要 Node.js 18 或更高版本,以及 Claude Code 或 Codex。
  • 若使用桌面版应用,需安装 Claude Code CLI,地图的提问功能才能读取你的实际代码。

收录于专题

标签

常见问题

floorplan 是什么?
由 Claude Code 或 Codex 绘制的交互式代码库地图,用通俗语言展示各部分、文件、接口及其连接关系。 Floorplan 是一个 Claude Code 和 Codex 插件,可以读取已有应用,生成可缩放、用通俗语言描述的应用地图。各个模块、文件和 Web 接口都会获得易懂的名称,文件之间的导入关系,以及前后端之间的请求,都会以连线标出,跨仓库的调用也能识别。
floorplan 可以免费使用吗?用的什么许可证?
floorplan 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
floorplan 还在维护吗?
活跃维护中。floorplan 最近一次提交是在 2026年11月2日。
floorplan 适合用来做什么?
在不通读全部代码的情况下,理解主要借助 AI 构建的应用 为新成员介绍多仓库项目的整体结构 回顾一次 AI 编码会话改动了什么以及原因 发布前排查常见的安全配置问题
floorplan 怎么安装和运行?
在 Claude Code 中添加 Floorplan 插件市场: claude plugin marketplace add haydenschmitty/floorplan 安装 Floorplan 插件: claude plugin install floorplan@floorplan 在新会话中让 Claude Code 为你的应用生成平面图 打开浏览器中出现的地图并进行探索
在哪里获取 floorplan?
源代码和安装说明在 GitHub 上:https://github.com/haydenschmitty/floorplan

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目