Skip to content

fix(docs): correct codex plugin install command (closes #476)#580

Open
rohitg00 wants to merge 1 commit into
mainfrom
fix/codex-install-docs
Open

fix(docs): correct codex plugin install command (closes #476)#580
rohitg00 wants to merge 1 commit into
mainfrom
fix/codex-install-docs

Conversation

@rohitg00
Copy link
Copy Markdown
Owner

@rohitg00 rohitg00 commented May 20, 2026

Summary

Closes #476.

Codex's plugin CLI exposes codex plugin add / list / remove / marketplace, not install. Verified against codex-rs/cli/src/plugin_cmd.rs:

pub enum PluginSubcommand {
    Add(...)         // codex plugin add <PLUGIN>[@<MARKETPLACE>]
    List(...)        // codex plugin list
    Remove(...)      // codex plugin remove <PLUGIN>
    Marketplace(...) // codex plugin marketplace <add|upgrade|remove>
}

Users following the current README hit:

$ codex plugin install agentmemory
error: unrecognized subcommand 'install'

Fix

Two callsites corrected to use codex plugin add agentmemory@agentmemory:

  • README.md — top-level Codex install snippet
  • README.md — agent matrix row
  • src/cli/connect/codex.ts — final info hint printed after agentmemory connect codex

CHANGELOG 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 agentmemory inside Claude Code are Claude's own slash API and remain correct.

Diff

3 lines across 2 files.

Validation

  • npm test → 1081/1081 tests pass
  • npm run build → clean

Summary by CodeRabbit

  • Documentation
    • Updated plugin installation command syntax from codex plugin install agentmemory to codex plugin add agentmemory@agentmemory in setup instructions and user-facing messages.

Review Change Stack

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.
@vercel
Copy link
Copy Markdown

vercel Bot commented May 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
agentmemory Ready Ready Preview, Comment May 20, 2026 4:17pm

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 20, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 252f380f-384e-414e-8703-f511749b4653

📥 Commits

Reviewing files that changed from the base of the PR and between edd1ceb and e9da107.

📒 Files selected for processing (2)
  • README.md
  • src/cli/connect/codex.ts

📝 Walkthrough

Walkthrough

This PR updates user-facing documentation and CLI messaging to reflect a breaking change in the Codex CLI API. The old codex plugin install agentmemory command is replaced with codex plugin add agentmemory@agentmemory across README setup instructions and the adapter's installation success message.

Changes

Codex Plugin Command Update

Layer / File(s) Summary
Update Codex plugin command references across docs and CLI output
README.md, src/cli/connect/codex.ts
README.md setup instructions in two locations (Codex CLI one-block snippet and agents configuration table) and the informational CLI message in adapter.install are updated from codex plugin install agentmemory to codex plugin add agentmemory@agentmemory.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • rohitg00/agentmemory#311: Introduces the Codex marketplace/manifest needed to support the codex plugin add full-plugin installation flow referenced in this PR's updated messaging.
  • rohitg00/agentmemory#564: Also modifies src/cli/connect/codex.ts in the same Codex adapter install area, adding --with-hooks fallback logic alongside the command syntax change.
  • rohitg00/agentmemory#5: Updates the same Codex CLI installation instructions in README.md reflecting the same underlying plugin command change.

Poem

🐰 Command words shift from install to add,
Throughout the docs, the good news spread,
From snippet to table, from code to log—
One syntax change clears the fog.
plugin add now shows the way,
agentmemory's here to stay!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: correcting a Codex plugin command from 'install' to 'add' in documentation.
Linked Issues check ✅ Passed The PR directly addresses issue #476 by updating all documented references from the non-existent 'codex plugin install' to the correct 'codex plugin add' subcommand.
Out of Scope Changes check ✅ Passed All changes are scoped to correcting the Codex plugin command documentation; no unrelated modifications are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/codex-install-docs

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

codex install fail

1 participant