fix(docs): correct codex plugin install command (closes #476)#580
fix(docs): correct codex plugin install command (closes #476)#580rohitg00 wants to merge 1 commit into
Conversation
Codex's plugin CLI (codex-rs/cli/src/plugin_cmd.rs) exposes: codex plugin add <PLUGIN>[@<MARKETPLACE>] codex plugin list codex plugin remove <PLUGIN> codex plugin marketplace <add|upgrade|remove> It does NOT have a `codex plugin install` subcommand. Users following the README would hit: error: unrecognized subcommand 'install' Fix two callsites that documented the wrong command: - README.md: top-level Codex install snippet + agent matrix row - src/cli/connect/codex.ts: final info hint after `agentmemory connect codex` CHANGELOG history is left alone since those entries reference what the README said at the time and rewriting history is not the right move. Slash-command references like `/plugin install agentmemory` inside Claude Code are unrelated and remain — that's Claude Code's slash API, not the codex CLI.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis PR updates user-facing documentation and CLI messaging to reflect a breaking change in the Codex CLI API. The old ChangesCodex Plugin Command Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsGit: Failed to clone repository. Please run the 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 |
Summary
Closes #476.
Codex's plugin CLI exposes
codex plugin add / list / remove / marketplace, notinstall. Verified againstcodex-rs/cli/src/plugin_cmd.rs:Users following the current README hit:
Fix
Two callsites corrected to use
codex plugin add agentmemory@agentmemory:README.md— top-level Codex install snippetREADME.md— agent matrix rowsrc/cli/connect/codex.ts— final info hint printed afteragentmemory connect codexCHANGELOG entries are left alone (those reference what the README said at the time; rewriting history isn't the right call). Slash-command references like
/plugin install agentmemoryinside Claude Code are Claude's own slash API and remain correct.Diff
3 lines across 2 files.
Validation
npm test→ 1081/1081 tests passnpm run build→ cleanSummary by CodeRabbit
codex plugin install agentmemorytocodex plugin add agentmemory@agentmemoryin setup instructions and user-facing messages.