diff --git a/integrations/codex/README.md b/integrations/codex/README.md index 3aba9ca3..41b16a9a 100644 --- a/integrations/codex/README.md +++ b/integrations/codex/README.md @@ -6,6 +6,8 @@ Connect Codex to your ReMe service to remember project decisions, preferences, a across conversations. ReMe can automatically record and recall memories, and organize them each day. Your memory files stay in your own ReMe workspace. +The screenshots below were captured in Codex desktop. Click an image to view it at full size. + ## Before you start - **Codex CLI >= 0.159.2** for installation and CLI use. Run `codex --version` to check. @@ -58,11 +60,7 @@ codex plugin add reme@reme-codex Restart the desktop app, or start a new CLI session. Open the installed ReMe entry and confirm it is enabled. -> **Screenshot placeholder — `plugin-installed.png`:** Actual Codex ReMe detail page, showing the enabled state and `reme` MCP card. - - +[![Installed ReMe details and MCP settings entry in Codex](./figures/plugin-installed.png)](./figures/plugin-installed.png) In the desktop app, add and open a local project folder before entering **Settings → Hooks**. Select **Local** if a host selector is shown, then review and trust **every ReMe entry** (currently seven). @@ -70,15 +68,12 @@ In the CLI, start `codex` from your project folder and use `/hooks`. This enables automatic recording and recall. A healthy service connection alone does not enable them. After an update, review any changed entries again. See [Codex Hook review and trust](https://learn.chatgpt.com/docs/hooks#review-and-trust-hooks). -> **Screenshot placeholder — `hooks-trusted.png`:** All seven ReMe entries enabled and trusted in Codex Hooks settings or `/hooks`. - - +[![The seven ReMe Hook entries in Codex settings](./figures/hooks-trusted.png)](./figures/hooks-trusted.png) ## 3. Connect through MCP settings -Open the installed ReMe entry, find its **reme MCP server** card, and choose **Open MCP settings**. +Open the installed ReMe entry, find its **reme MCP server** card, and click the settings gear +(**Open MCP settings**). Use this form to change the service address and memory options. You do not need to edit a configuration file. For a first test, save these values: @@ -95,11 +90,9 @@ Save, then click **ReMe status**. In **Overview**, check that the service is **H version is shown. If it is unavailable, expand **Connection details** to check the address and confirm that your service is running. Next, try recording and recalling a memory. -> **Screenshot placeholder — `mcp-settings.png`:** Actual native form with the address, capture switches, batch size, and the single ReMe status entry. +[![ReMe service address, automatic memory options, and Dream schedule in Codex settings](./figures/mcp-settings.png)](./figures/mcp-settings.png) - +The screenshot uses `http://127.0.0.1:2444/mcp`; enter your own service address. ## 4. Try your first memory @@ -115,11 +108,7 @@ Auto Memory → Recent activity** and look for **Memory saved** (`memory_saved`) should return to zero. You can also read the saved note under `daily/` in your ReMe workspace. Wait for the saved status before continuing; Codex's acknowledgement alone does not confirm recording. -> **Screenshot placeholder — `memory-recorded.png`:** Conversation A with the project decision and acknowledgement. - - +[![Conversation A supplies the project decision and receives an acknowledgement](./figures/memory-recorded.png)](./figures/memory-recorded.png) Start a separate conversation B: @@ -133,11 +122,7 @@ To confirm automatic recall, check **Auto Memory → Recent activity** for **Rel (`recall_found`). A correct answer without that event does not confirm that automatic recall is enabled. Use **Show all … events** if it is outside the latest five activities. -> **Screenshot placeholder — `memory-recalled.png`:** Separate conversation B with the recalled facts and source path. - - +[![Conversation B recalls the review time, keyword, and ReMe source path](./figures/memory-recalled.png)](./figures/memory-recalled.png) For everyday use, ask naturally: “What did we decide about this project's release process?” or “Find my earlier preferences for code reviews.” You can adjust **Capture batch size** after the first @@ -155,8 +140,8 @@ Open **ReMe status → Consolidation** to check the next run and latest result. running at the scheduled time; missed runs are not made up after restarting. If several machines use the same ReMe workspace, enable daily consolidation on only one of them. -To organize your memories now, wait for **Queued turns** to reach zero, then click **Consolidate now -(updates memory files)** in MCP settings. This updates your memory files and also works when the daily +To organize your memories now, wait for **Queued turns** to reach zero, then click **Consolidate ReMe +memory now** in MCP settings. This updates your memory files and also works when the daily schedule is off. Check **Consolidation** for the result. Turning off the schedule does not stop an already-started run; after a timeout, check its status before trying again. @@ -177,11 +162,9 @@ Expand an event for its full timestamp and diagnostic details; use **Show all If you prefer a text answer, ask Codex: “Call `reme_status` and summarize my connection, pending memories, and next consolidation.” -> **Screenshot placeholder — `plugin-status.png`:** Real ReMe status panel on Auto Memory, with queued turns and Recent activity expanded to show saved and recalled memories. +[![ReMe status Overview shows a healthy service and zero queued turns and sessions](./figures/plugin-status.png)](./figures/plugin-status.png) - +Overview shows the service health and pending turns. Select **Auto Memory** to inspect recording and recall activity. Change options in **Open MCP settings**, then save. New settings apply to subsequent activity; you do not need to reinstall. Common adjustments are listed below using the names shown in the form. diff --git a/integrations/codex/README_ZH.md b/integrations/codex/README_ZH.md index e1852918..56c1a73c 100644 --- a/integrations/codex/README_ZH.md +++ b/integrations/codex/README_ZH.md @@ -5,6 +5,8 @@ 将 Codex 接入自己的 ReMe 服务，即可跨会话记住项目决策、个人偏好和待办事项。 ReMe 可以自动记录、召回记忆，并每天整理。记忆文件保存在你自己的 ReMe 工作区中。 +下方为真实 Codex 桌面端截图，点击图片可查看原图。 + ## 开始前 - **Codex CLI >= 0.159.2**：用于安装和命令行使用，运行 `codex --version` 查看版本。 @@ -55,11 +57,7 @@ codex plugin add reme@reme-codex 重启桌面客户端，或打开新的 CLI 会话。在已安装的 ReMe 详情中确认已启用。 -> **截图槽位 — `plugin-installed.png`：** 真实 Codex 中的 ReMe 详情页，保留启用状态和 `reme` MCP 卡片。 - - +[![Codex 中已安装的 ReMe 详情与 MCP 设置入口](./figures/plugin-installed.png)](./figures/plugin-installed.png) 桌面端请先添加并打开一个本地项目文件夹，再进入 **Settings → Hooks**。 如果出现主机选择，选择 **Local**，然后审核并信任 **所有 ReMe 条目**（目前共七个）。 @@ -67,15 +65,11 @@ CLI 请在项目目录启动 `codex`，再使用 `/hooks`。 完成这一步才能自动记录和召回。仅连接服务并不会启用这些能力。 升级后如条目发生变化，需要重新审核。参见 [Codex Hook 审核与信任说明](https://learn.chatgpt.com/docs/hooks#review-and-trust-hooks)。 -> **截图槽位 — `hooks-trusted.png`：** Codex Hooks 设置或 `/hooks` 中，七个 ReMe 条目均已启用、已信任。 - - +[![Codex 设置中的七个 ReMe Hook 条目](./figures/hooks-trusted.png)](./figures/hooks-trusted.png) ## 3. 在 MCP 设置中连接服务 -打开已安装的 ReMe 详情，找到 **reme MCP server** 卡片，点击 **Open MCP settings**。 +打开已安装的 ReMe 详情，找到 **reme MCP server** 卡片，点击齿轮设置图标（**Open MCP settings**）。 在这个表单中调整服务地址和记忆选项，无需手动编辑配置文件。 首次验证建议保存以下配置： @@ -91,11 +85,9 @@ CLI 请在项目目录启动 `codex`，再使用 `/hooks`。 先保存，再点击 **ReMe status**。在 **总览** 中确认服务显示 **健康**，并能看到 ReMe 版本。 若无法连接，展开 **连接详情** 核对地址，并确认服务正在运行。接下来尝试记录和召回一条记忆。 -> **截图槽位 — `mcp-settings.png`：** 真实原生表单，保留服务地址、自动开关、批次大小及唯一的 ReMe status 入口。 +[![Codex 设置中的 ReMe 服务地址、自动记忆选项和 Dream 计划](./figures/mcp-settings.png)](./figures/mcp-settings.png) - +截图使用 `http://127.0.0.1:2444/mcp`，请填写你自己的服务地址。 ## 4. 记录并召回第一条记忆 @@ -111,11 +103,7 @@ Codex 回复后，保持会话打开，等待记录完成。打开 **ReMe status 也可以在 ReMe 工作区的 `daily/` 下阅读保存的笔记。 看到保存成功后再进行下一步；Codex 的确认回复本身不能证明记忆已写入。 -> **截图槽位 — `memory-recorded.png`：** 会话 A 中的项目决策和确认回复。 - - +[![会话 A 中提交项目决策并收到确认回复](./figures/memory-recorded.png)](./figures/memory-recorded.png) 另建会话 B： @@ -129,11 +117,7 @@ ReMe-Example-7319 的评审时间和项目关键词是什么？ 仅答对问题、却没有这条活动记录，不能证明自动召回已开启。 如果不在最近五条活动中，点击 **查看全部 … 条活动**。 -> **截图槽位 — `memory-recalled.png`：** 独立会话 B 中的正确事实和 ReMe 来源路径。 - - +[![会话 B 中召回评审时间、关键词和 ReMe 来源路径](./figures/memory-recalled.png)](./figures/memory-recalled.png) 日常使用时，直接提问即可，例如“我们之前确定的发布流程是什么？”或“找一下我之前的代码评审偏好”。 首次验证后可调整 **Capture batch size**：默认每五次完成的回复记录一批；希望每次回复后尽快保存时，设为 `1`。 @@ -151,7 +135,7 @@ ReMe-Example-7319 的评审时间和项目关键词是什么？ 多台机器共用同一个 ReMe 工作区时，只在其中一台开启每日整理。 需要立即整理时，等待 **待提交轮数** 回到零，再在 MCP 设置中点击 -**Consolidate now (updates memory files)**。该操作会更新记忆文件，关闭每日计划后仍可使用。 +**Consolidate ReMe memory now**。该操作会更新记忆文件，关闭每日计划后仍可使用。 整理后到 **记忆整理** 页签查看结果。关闭计划不会停止已经开始的整理；如果出现超时，先检查状态再重试。 ## 6. 查看状态和调整使用偏好 @@ -171,11 +155,9 @@ ReMe-Example-7319 的评审时间和项目关键词是什么？ 也可以在对话中要求：“调用 `reme_status`，用文字告诉我连接状态、 待保存记忆和下次整理时间。” -> **截图槽位 — `plugin-status.png`：** 真实 ReMe status 面板的自动记忆页签，保留待提交轮数，并展开最近活动展示保存和召回记录。 +[![ReMe status 总览：服务健康，待提交轮数和会话数均为零](./figures/plugin-status.png)](./figures/plugin-status.png) - +总览展示服务健康状态和待提交轮数；查看记录与召回活动时，切换到 **Auto Memory** 页签。 需要调整时，回到 **Open MCP settings** 修改并保存。新设置对后续活动生效，无需重新安装。 下面按表单中显示的名称列出常用选项。 diff --git a/integrations/codex/figures/README.md b/integrations/codex/figures/README.md index edcd9705..4e928a08 100644 --- a/integrations/codex/figures/README.md +++ b/integrations/codex/figures/README.md @@ -1,10 +1,10 @@ # Codex manual screenshot workflow / 手动截图流程 -仅使用真实 Codex 界面截图。按下面的顺序完成六张必需截图，中英文使用说明共用同一组 PNG。 -截图槽位在收到对应图片前保留；无需为两种语言各拍一套。 +六张真实 Codex 截图已接入[中文使用指南](../README_ZH.md)和[English guide](../README.md)， +两种语言共用同一组 PNG。下面保留重新拍摄和补图的流程。 -Use real Codex screenshots only. Follow the capture order below; the English and Chinese guides share -the same six PNGs. Keep each placeholder until its corresponding screenshot is available. +All six real Codex screenshots are included in both guides, which share the same PNGs. +Use the workflow below when replacing or adding captures. ## 开始前 / Before capture @@ -50,7 +50,7 @@ the same six PNGs. Keep each placeholder until its corresponding screenshot is a | 3 | `mcp-settings.png` | 原生 **Open MCP settings** 表单 / Native settings | 已保存地址、自动开关、批次大小；**ReMe status** 入口可见 / Saved address, switches, batch size, and status action visible | | 4 | `memory-recorded.png` | 独立会话 A / Conversation A | 测试事实和回复可见，后台已出现 `memory_saved` / Fact and reply visible, recording confirmed | | 5 | `memory-recalled.png` | 新建会话 B / New conversation B | 问题、正确时间、校验词和来源路径可见，已出现 `recall_found` / Answer, source path, and automatic recall confirmed | -| 6 | `plugin-status.png` | **ReMe status → 自动记忆 / Auto Memory** | 最近活动已展开，可见保存和召回记录，待提交轮数为零 / Activity expanded, saved/recalled events visible, queue zero | +| 6 | `plugin-status.png` | **ReMe status → 总览 / Overview** | 健康状态、ReMe 版本和待提交轮数可见 / Health, version, and queue visible | ### 1. 已安装并启用 / Installed and enabled @@ -146,24 +146,26 @@ A correct answer alone does not establish that automatic recall ran. ### 6. 展示状态面板 / Capture the status panel -再次从原生设置打开 **ReMe status**，选择 **自动记忆 / Auto Memory**，点击刷新并展开 **最近活动 / Recent activity**。 -等待会话 B 的记录也保存完成、待提交轮数回到 `0`，再截取标题、页签、自动记录与召回状态及本次保存和召回活动， -保存为 `plugin-status.png`。 -在最近活动仍保留这两条记录时拍摄，避免继续发送无关测试消息。 -若需要展示的记录不在最近五条中，先点击 **查看全部 … 条活动 / Show all … events**。 +再次从原生设置打开 **ReMe status**，选择 **总览 / Overview**，点击刷新。 +等待会话 B 的记录也保存完成、待提交轮数回到 `0`，再截取标题、页签、健康状态、ReMe 版本和待提交轮数， +保存为 `plugin-status.png`。当前使用指南展示的是这个页签。 -Open the real status panel, select Auto Memory, refresh, and expand Recent activity. Capture the tabs, -automatic switches, zero pending turns after B is also saved, and the saved/recalled events before unrelated activity replaces them. +Open the real status panel, select Overview, and refresh. After B is also saved, capture the title, +tabs, health, ReMe version, and zero pending turns. This is the tab shown in the current guides. + +需要补充自动记忆活动截图时，切换到 **自动记忆 / Auto Memory**，展开 **最近活动 / Recent activity**， +保留本次 `memory_saved` 和 `recall_found`。若不在最近五条中，点击 **查看全部 … 条活动 / Show all … events**。 +For an activity capture, select Auto Memory and expand Recent activity to show `memory_saved` and `recall_found`. Use Show all … events if the needed entries are outside the latest five. 状态面板的总览、自动记忆和记忆整理是不同页签，不需要把所有内容挤到一张图里。 可另拍以下真实页面；没有开启每日计划时，显示暂停或没有计划是有效状态，无需为截图改动计划或执行整理。 -The tabs show different information. Optional captures below can show connection health and Dream separately; +The tabs show different information. Optional captures below can show automatic memory and Dream separately; a paused schedule is valid, so there is no need to enable or run consolidation just for a screenshot. | 可选文件 / Optional file | 内容 / Content | | --- | --- | -| `plugin-status-overview.png` | **总览 / Overview** 中的健康状态、ReMe 版本和待提交轮数 / Health, version, and queue | +| `plugin-status-memory.png` | **自动记忆 / Auto Memory** 中的开关和保存、召回活动 / Switches and saved/recalled events | | `plugin-status-dream.png` | **记忆整理 / Consolidation** 中的 cron、时区、下次运行和最近结果 / Schedule, timezone, next run, and last result | ## 遇到失败时 / If a step fails @@ -190,28 +192,25 @@ integrations/codex/figures/ └── plugin-status.png ``` -图片保存好后即可交给维护者接入文档；若自行完成，对每张已存在的图片依次执行： -Once the files are ready, hand them off for integration, or make these changes yourself for each supplied image: +六张图片已接入文档。后续更新时覆盖对应文件，确认中英文说明与实际画面一致，并保留原图链接，例如： +The six images are already linked. To update them, replace the corresponding PNG, check that both guides +describe the captured screen accurately, and retain the link to the full-size image: -1. 在 `../README.md` 和 `../README_ZH.md` 中找到同名截图槽位，删除对应的可见占位引用块。 - Remove its visible screenshot-placeholder blockquote in both guides. -2. 移除对应图片行外的 ``，保留相对路径。例如： - Uncomment the matching image line, keeping its relative path: +```markdown +[![ReMe MCP settings in Codex](./figures/mcp-settings.png)](./figures/mcp-settings.png) +``` - ```markdown - ![ReMe MCP settings in Codex](./figures/mcp-settings.png) - ``` +可选补图放在相关必需图片后，在中英文说明中分别加上对应图片行。 +Add optional images after their related required image, with captions in each language. -3. 缺少图片的槽位继续保留。可选补图放在相关必需图片后，在中英文说明中分别加上对应图片行。 - Leave missing-image slots intact. Add optional images after their related required image, with captions in each language. -4. 从仓库根目录执行以下检查，再打开预览中的中英文 Codex 页面，确认图片加载、文字清晰且排版正常： - Run these checks from the repository root, then inspect both Codex guide pages in the preview: +从仓库根目录执行以下检查，再打开预览中的中英文 Codex 页面，确认图片加载、文字清晰且排版正常： +Run these checks from the repository root, then inspect both Codex guide pages in the preview: - ```bash - npm --prefix github-pages test - npm --prefix github-pages run build - npm --prefix github-pages run preview - ``` +```bash +npm --prefix github-pages test +npm --prefix github-pages run build +npm --prefix github-pages run dev +``` 不要提交服务日志、对话导出文件、配置凭据或临时记忆工作区。只提交已审核的 PNG 和对应文档修改。 Commit the reviewed PNGs and documentation changes; keep logs, transcript exports, credentials, and demo memory out of the commit. diff --git a/integrations/codex/figures/hooks-trusted.png b/integrations/codex/figures/hooks-trusted.png new file mode 100644 index 00000000..aaf9af1c Binary files /dev/null and b/integrations/codex/figures/hooks-trusted.png differ diff --git a/integrations/codex/figures/mcp-settings.png b/integrations/codex/figures/mcp-settings.png new file mode 100644 index 00000000..4403771f Binary files /dev/null and b/integrations/codex/figures/mcp-settings.png differ diff --git a/integrations/codex/figures/memory-recalled.png b/integrations/codex/figures/memory-recalled.png new file mode 100644 index 00000000..e349d619 Binary files /dev/null and b/integrations/codex/figures/memory-recalled.png differ diff --git a/integrations/codex/figures/memory-recorded.png b/integrations/codex/figures/memory-recorded.png new file mode 100644 index 00000000..af042b49 Binary files /dev/null and b/integrations/codex/figures/memory-recorded.png differ diff --git a/integrations/codex/figures/plugin-installed.png b/integrations/codex/figures/plugin-installed.png new file mode 100644 index 00000000..22fa2a99 Binary files /dev/null and b/integrations/codex/figures/plugin-installed.png differ diff --git a/integrations/codex/figures/plugin-status.png b/integrations/codex/figures/plugin-status.png new file mode 100644 index 00000000..9bb02d75 Binary files /dev/null and b/integrations/codex/figures/plugin-status.png differ