Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 1.81 KB

README.md

File metadata and controls

18 lines (15 loc) · 1.81 KB

Floorplan documentation

Guide What's in it
Getting started Installing, making your first map, keeping it updated, planning an app before it exists, updating and removing the plugin
Floorplan in Codex Installing and using Floorplan in Codex, and what's different from Claude Code
Using the map Every button, view, panel, shortcut and right-click menu, and what a blueprint adds
How it works The pipeline from scan to map, how connections are found, how updates stay cheap, how blueprints are drawn and changed
What's in your project Every file Floorplan creates, which ones you can edit, and how it stays out of git
Privacy and security What runs where, what leaves your machine, and how secrets are handled
Is it safe to install? Everything Floorplan does on your computer, how a test enforces it, and how to verify your installed copy
Troubleshooting Common problems and how to fix them
Running without an agent session Running Floorplan in CI, in scripts or from your own tooling: unattended mode, results as JSON, exit codes and the workflow file
Developing Floorplan Repo layout, testing a local copy, releasing a new version

New here? Start with Getting started.

Floorplan is mainly for mapping code you already have, and every guide is written for that. It can also draw a blueprint, a map planned from a PRD or spec before the code exists: see Plan something you haven't built yet, Blueprints on the map and how blueprints work.