floorplan

了解您的應用程式實際如何組合在一起。由 Claude 或 Codex 繪製的互動式、白話文程式碼庫地圖。

floorplan 是什麼?

了解您的應用程式實際如何組合在一起。由 Claude 或 Codex 繪製的互動式、白話文程式碼庫地圖。

floorplan 概覽

這是什麼

Floorplan 是一個由 Claude 或 Codex 繪製的互動式、使用平實英文呈現的程式碼地圖。它會讀取你的程式碼,並以人類可讀的名稱顯示每個部分、檔案和網路請求,以及它們之間的所有連結。它在你自己的機器上執行,不會將任何內容提交到 git。

主要功能

  • 每個縮放層級都有地圖:從整個應用程式開始,然後雙擊進入某個部分、一組檔案、一個檔案及其端點。每個檢視畫面都會顯示它被哪些部分使用,以及它使用了哪些部分。
  • 到處都是平實英文:將滑鼠懸停在技術術語上會顯示說明,一個切換開關可以顯示開發者檢視。
  • 跨儲存庫的真實連結:它會追蹤匯入,並將前端中的每個網路請求與回應它的伺服器端點進行配對,即使它們位於不同的儲存庫中。
  • 從畫面開始:選擇一個你認識的頁面,就能看到它背後的一切:它的組成部分、它發出的請求、伺服器程式碼、資料以及外部服務。
  • 詢問地圖:像「退款如何到達客戶的信用卡?」這樣的問題會回傳一個答案,以及一個僅包含相關元件的迷你地圖,並附有逐步解說。
  • 健康檢查:捕捉 AI 建構的應用程式中常見的錯誤——程式碼中的金鑰、開放的 Supabase 資料表、開放的 Firebase 規則、可偽造的 Stripe Webhook,以及無需登入的端點——每個錯誤都附帶一個可直接貼上的修復方法。
  • 近期工作:你的 AI 剛更改過的卡片會亮起綠色,每張卡片都附有一則說明,解釋該變更如何服務於你的要求。

使用情境

  • 對於建構者:用你自己的話來理解你製作的應用程式,無需閱讀程式碼。
  • 對於團隊:在幾分鐘內讓新人上手,從宏觀圖景一直到確切的檔案。
  • 對於與 AI 協作:在 Claude 或 Codex 每次變更後,準確查看它觸及了哪些部分以及原因。

快速開始

你需要 Node.js 18+ 以及 Claude Code 或 Codex。Floorplan 在你已有的方案上執行,無需 API 金鑰。對於 Claude Code:bashclaude plugin marketplace add haydenschmitty/floorplanclaude plugin install floorplan@floorplan對於 Codex:1. 在 Codex 應用程式中,開啟 Plugins 並選擇 Add a marketplace。2. 在 Source 中,輸入 haydenschmitty/floorplan 並點擊 Add marketplace。3. 找到 Floorplan 並點擊 + 來安裝它。或者,從終端機:bashcodex plugin marketplace add haydenschmitty/floorplancodex plugin add floorplan@floorplan快速入門:1. 在 Claude Code 或 Codex 中開啟你的專案。如果前端和後端在不同的儲存庫中,請開啟包含兩者的資料夾。2. 詢問:「為這個應用程式製作一個 floorplan。」(在 Codex 中你也可以輸入 $floorplan。)3. 開始探索。地圖會自行開啟,並從一個簡短的導覽開始。

授權與價格

授權條款:MIT。定價類型:開放原始碼。

內容整理自該專案公開的 README 與儲存庫資訊。

將此徽章加入你的 README

Featured on YunoDB 徽章樣式與說明

你是這個專案的維護者嗎?展示它已收錄於 YunoDB。

Markdown[![Featured on YunoDB](https://yunodb.com/badge/haydenschmittyfloorplan.svg)](https://yunodb.com/tools/haydenschmittyfloorplan?utm_source=github&utm_medium=badge)
HTML<a href="https://yunodb.com/tools/haydenschmittyfloorplan?utm_source=github&utm_medium=badge"><img src="https://yunodb.com/badge/haydenschmittyfloorplan.svg" alt="Featured on YunoDB" height="20"></a>