haydenschmitty/floorplan

选用指南

AI 根据 README 整理 · 2026/10/29 00:51:46

适用场景

适用于理解大型或跨仓库代码库、团队快速上手、以及跟踪 AI 辅助开发后的变更影响。

查看 README 依据

- **For builders:** understand the app you made, in your own words, without reading the code. - **For teams:** onboard someone in minutes, from the big picture down to the exact file. - **For working with Claude:** after every change, see exactly which parts it touched and why. ## Features <table> <tr> <td width="50%" valign="top"> **🗺️ A map at every zoom**<br> Start with the whole app, then double-click into a part, a group of files, a file, and its endpoints. Each view shows what it's used by and what it uses. </td> <td width="50%" valign="top"> **💬 Plain English everywhere**<br>

"Takes card payments at checkout", not "Stripe API wrapper". Technical terms are explained on hover, and one switch shows the developer view. </td> </tr> <tr> <td valign="top"> **🔌 Real connections, across repos**<br> It follows imports, and matches each web request in your frontend to the server endpoint that answers it, even across separate repos. </td> <td valign="top"> **🖥️ Start from a screen**<br> Pick a page you know and see everything behind it: its parts, the requests it makes, the server code, the data, and outside services. </td> </tr> <tr> <td valign="top">

使用方式

通过 Claude Code 插件安装，在会话中请求生成地图，地图在浏览器中打开，可交互探索和提问。

查看 README 依据

</td> </tr> </table> ## Install You need [Claude Code](https://code.claude.com/docs/en/overview) (the desktop app's Code tab or the CLI) and [Node.js 18+](https://nodejs.org). ```bash claude plugin marketplace add haydenschmitty/floorplan claude plugin install floorplan@floorplan ``` Start a new session and it's ready. Installing the Claude Code CLI is recommended even if you use the desktop app, because it lets the map's Ask bar read your real code. More in [Getting started](docs/getting-started.md). ## Quick start

1. Open your project in Claude Code. For a frontend and backend in separate repos, open the folder that holds both. 2. Ask: > Make me a floorplan of this app. 3. Explore. The map opens on its own, starting with a short tour. When you've done more work, ask: > Update the floorplan. Only what changed is re-read, and what you just worked on lights up under **Recent work**. ### Things to try | Ask Claude | Ask the map | |---|---| | "Make me a floorplan of this app" | "What happens when someone places an order?" | | "Update the floorplan" | "Where do we talk to Stripe?" |

部署要求

需要 Claude Code（桌面应用的 Code 标签页或 CLI）和 Node.js 18+。

查看 README 依据

</td> </tr> </table> ## Install You need [Claude Code](https://code.claude.com/docs/en/overview) (the desktop app's Code tab or the CLI) and [Node.js 18+](https://nodejs.org). ```bash claude plugin marketplace add haydenschmitty/floorplan claude plugin install floorplan@floorplan ``` Start a new session and it's ready. Installing the Claude Code CLI is recommended even if you use the desktop app, because it lets the map's Ask bar read your real code. More in [Getting started](docs/getting-started.md). ## Quick start

已知限制

首次生成地图需要几分钟，大型项目更久，且会消耗 Claude 计划额度。

查看 README 依据

<summary><b>How long does it take, and what does it cost?</b></summary> A first map takes a few minutes for a small app and longer for a big one, because Claude describes every file and endpoint. It uses your Claude plan like any other task. Big projects are split across parallel helpers. Updates re-read only what changed, so they're quick and cheap. </details> <details> <summary><b>Do I need the Claude Code CLI?</b></summary>