docs: add Codex install notes to plugin README#70
Conversation
📝 WalkthroughWalkthroughThe plugin README is updated to provide explicit, host-aware setup instructions. Claude Code installation steps are now under a dedicated subsection header. Codex installation and uninstallation workflows are newly documented, including the ChangesHost-Specific Setup Documentation
Possibly Related PRs
Poem
🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Tools execution failed with the following error: Failed to run tools: 13 INTERNAL: Received RST_STREAM with code 2 (Internal server error) Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
plugin/README.md (2)
28-36: ⚡ Quick winConsider aligning restart terminology between hosts.
Line 28 says "restart Claude Code" while line 36 says "fully quit and reopen Codex so hooks reload." If both hosts require a full quit-and-reopen for hooks to reload (rather than just a soft restart), consider using consistent wording. The Codex instruction's explicit mention of hook reloading is helpful context that could benefit Claude Code users as well.
📝 Optional consistency improvement
-Then restart Claude Code. +Then fully quit and reopen Claude Code so hooks reload.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@plugin/README.md` around lines 28 - 36, The README uses inconsistent restart terminology between "restart Claude Code" and "fully quit and reopen Codex so hooks reload"; update the Claude Code section (the sentence referencing "restart Claude Code") to mirror the Codex wording and explicitly state "fully quit and reopen" and mention hooks reload so both host instructions (Claude Code and the Codex command shown as `npx claude-smart install --host codex`) use the same clear guidance about requiring a full quit-and-reopen for hooks to take effect.
43-51: ⚡ Quick winConsider adding restart instruction after Claude Code uninstall.
The Codex uninstall section (line 59) instructs users to "Restart Codex after uninstalling," but the Claude Code uninstall section has no equivalent restart instruction. If Claude Code also requires a restart to fully unload hooks, this guidance should be added for symmetry and user clarity.
📝 Proposed addition for consistency
```bash npx claude-smart uninstall # or: uvx claude-smart uninstall
+Then restart Claude Code.
</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.In
@plugin/README.mdaround lines 43 - 51, Add a one-line restart instruction to
the Claude Code uninstall section so it matches the Codex guidance: after the
existing uninstall commands (the "claude plugin uninstall
claude-smart@reflexioai" and the "npx claude-smart uninstall" / "uvx
claude-smart uninstall" variants) append a short sentence telling the user to
restart Claude Code to fully unload the plugin/hooks.</details> <!-- cr-comment:v1:47e5a8a3c6712851e4355f38 --> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.Nitpick comments:
In@plugin/README.md:
- Around line 28-36: The README uses inconsistent restart terminology between
"restart Claude Code" and "fully quit and reopen Codex so hooks reload"; update
the Claude Code section (the sentence referencing "restart Claude Code") to
mirror the Codex wording and explicitly state "fully quit and reopen" and
mention hooks reload so both host instructions (Claude Code and the Codex
command shown asnpx claude-smart install --host codex) use the same clear
guidance about requiring a full quit-and-reopen for hooks to take effect.- Around line 43-51: Add a one-line restart instruction to the Claude Code
uninstall section so it matches the Codex guidance: after the existing uninstall
commands (the "claude plugin uninstall claude-smart@reflexioai" and the "npx
claude-smart uninstall" / "uvx claude-smart uninstall" variants) append a short
sentence telling the user to restart Claude Code to fully unload the
plugin/hooks.</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro Plus **Run ID**: `6d4cb5b4-84af-4c20-9f5d-0291f4fcc5b5` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between cefa8010d852cc3ad4b41793ab3e9b06f0d7a60e and c077f05ce149f6bb9adc8c1bf5706a83dd06613b. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `plugin/README.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
1 participant
Summary
Test Plan / Validation
git diff --checkplugin/README.mdMarketing rationale
Codex support is a meaningful discovery and conversion hook for developers comparing local agent memory tools. The PyPI/plugin README is a public-facing package surface, so making Codex installation obvious reduces friction without changing product claims.
Summary by CodeRabbit