跳转至

Floorplan in Codex

Floorplan 在 Codex 中的工作方式与在 Claude Code 中相同:使用相同的技能、脚本和地图,并在你自己的 ChatGPT 登录状态下运行。无需设置任何 API 密钥。

What you need

  • Codex:桌面应用或 CLI,使用你的 ChatGPT 账户登录。
  • Node.js 18 或更新版本。

Install

在 Codex 应用中(无需终端):

  1. 打开 Plugins,然后选择 Add a marketplace。
  2. 在 Source 中输入 haydenschmitty/floorplan。将 Git ref 留空,然后点击 Add marketplace。
  3. 在列表中找到 Floorplan,然后点击 + 进行安装。
  4. 开始一个新的聊天。

从终端,使用 Codex CLI:

codex plugin marketplace add haydenschmitty/floorplan
codex plugin add floorplan@floorplan

应用和 CLI 共享插件,因此在一个中安装后,Floorplan 在两者中都可用。

Make your first map

在 Codex 中打开你的项目,然后用简单的语言提问:

Draw a floorplan of this codebase

要按名称调用技能,请输入 $floorplan。之后的流程与在 Claude Code 中相同(快速入门):Codex 扫描代码,描述每个部分、文件和 Web 请求,构建地图并打开它。之后,“update the floorplan” 只会重新读取已更改的内容。

当 Codex 打开地图时,它会请求在地图的沙箱之外运行其服务器。服务器必须在命令结束后继续运行,并且 Ask 栏需要能够访问 Codex。如果你不想允许这样做,可以在项目文件夹中自行运行服务器:

node floorplan/serve.mjs

Asking questions on the map

地图的 Ask 栏会在你的计算机上运行你自己的 Codex:在 Codex 的 只读 沙箱中,在你的项目文件夹内,使用你的 ChatGPT 登录状态执行 codex exec。它会读取地图和你的源代码来回答,并且无法更改任何文件。这些运行不会保存到你的 Codex 历史记录中;后续提问会附带最近几个问题和答案。

服务器使用构建地图的那个代理,如果该代理未安装,则回退到另一个代理。若要选择:

node floorplan/serve.mjs --engine codex

它会在你的 PATH 中查找 codex,在 Windows 上则使用 Codex 桌面应用自带的 CLI。如果你的 codex 在其他位置,请传递 --codex /path/to/codex。--model <name> 用于选择模型;否则由你的 Codex 设置决定。

What's different from Claude Code

  • 没有备注文件。 在 Claude Code 中,Floorplan 会在 CLAUDE.local.md 中保存一条简短备注(个人使用,永不提交),以便将未来的会话指向地图。Codex 没有对应的个人且不提交的机制(AGENTS.md 会与你的团队共享),因此 Floorplan 在 Codex 中不会改动你项目的备注。
  • 没有 Claude 应用。 将地图发布到 Claude 应用是 Claude 的一项功能。在 Codex 中,地图会在你的浏览器中打开,并从你的计算机提供服务。
  • “Fix with Codex”。 Health 面板中现成的修复提示用于粘贴到 Codex。在蓝图上,Build this with Codex 也是如此,Ask 栏的 Change 开关也会在只读沙箱中运行 Codex:Codex 会用更新后的计划回复,地图的服务器会保存它。

Update or remove it

在应用中,打开 Plugins,找到 Floorplan 市场,然后选择 Upgrade 获取最新版本,或选择 Remove marketplace 将其移除。在终端中:

codex plugin marketplace upgrade floorplan
codex plugin add floorplan@floorplan
codex plugin remove floorplan@floorplan
codex plugin marketplace remove floorplan

你的地图会保留在各自项目的 floorplan/ 文件夹中,直到你删除它们。

Trying a working copy

将 Codex 指向你的本地克隆,而不是 GitHub:

codex plugin marketplace add /path/to/floorplan
codex plugin add floorplan@floorplan

Codex 会在你添加本地插件时将其复制到缓存中(这与 Claude Code 不同,Claude Code 直接从文件夹运行本地插件)。更改插件后,再次运行 codex plugin add floorplan@floorplan,然后开始一个新的会话。

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 floorplan/floorplan