# Floorplan

> A Claude Code and Codex plugin that draws an interactive, plain-English map of your codebase showing parts, files, web requests and connections.

Floorplan is an open-source plugin for Claude Code and Codex, published by haydenschmitty under the MIT license. It has Claude or Codex read a codebase and draw an interactive map in which every part, file and web request gets a plain-English name and every connection is shown. The latest release listed is version 0.3.0.

## What It Is

Floorplan is a codebase visualization and onboarding tool for people who want to understand how an app fits together without reading the code. You open a project (one repo or several) in Claude Code or Codex and ask for a floorplan. Scripts scan files, imports, routes and requests, then the AI names the parts and describes each file. The result is a map written to a local `floorplan/index.html` that opens in the browser.

## How the map is used

The map works at several zoom levels, from the whole app down to a part, a group of files, a file and its endpoints. It matches frontend web requests to the server endpoints that answer them, including across separate repos. Users can start from a screen to see the parts, requests, server code, data and outside services behind it. An Ask bar returns answers with a mini-map and walkthrough. Guided flows trace a request step by step, and a Recent work view highlights cards the AI just changed, with notes tying each change to what was asked.

## Health check and blueprints

A Health check flags secrets written into code, endpoints usable without sign-in, unused files and files too large to edit safely, each with a ready-to-paste fix prompt. Floorplan can also start from a PRD or spec and draw a blueprint of a planned system, shown with dashed cards, which becomes a map of the real code once it exists.

## Setup and privacy model

It requires Node.js 18+ and Claude Code or Codex, and runs on the plan you already have with no API keys. Install is through a plugin marketplace. The scan, map and local server run on your machine, and the README states there is no analytics or tracking. It writes only a `floorplan/` folder, plus a section in `CLAUDE.local.md` in Claude Code, and neither is committed to git. A live demo maps a sample coffee-subscription app called Brewline.

## Features
- Interactive codebase map with multiple zoom levels
- Plain-English names and descriptions for parts, files and endpoints
- Cross-repo matching of frontend requests to server endpoints
- Start from a screen view
- Ask the map questions with mini-map answers
- Health check for secrets, unauthenticated endpoints, unused and oversized files
- Recent work view highlighting AI-changed cards
- Guided flows
- Blueprints from a PRD or spec
- Incremental updates that re-read only changed files
- Local-only operation with no analytics
- Monorepo and multi-repo support

## Integrations
Claude Code, Codex

## Platforms
WEB, API, CLI

## Pricing
Open Source

## Version
0.3.0

## Links
- Website: https://haydenschmitty.github.io/floorplan-demo/
- Documentation: https://github.com/haydenschmitty/floorplan/blob/main/docs/README.md
- Repository: https://github.com/haydenschmitty/floorplan
- EveryDev.ai: https://www.everydev.ai/tools/floorplan
