Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
80 lines (54 loc) · 1.9 KB

DEVELOPMENT.md

File metadata and controls

80 lines (54 loc) · 1.9 KB

Basic Memory Codex Plugin Development

This plugin is developed in-place from the Basic Memory repository. Codex installs local plugins through marketplaces, so local testing uses a repo-local marketplace wrapper rather than publishing anything external.

Local Marketplace

The repo marketplace lives at:

.agents/plugins/marketplace.json

It exposes this plugin as:

codex@basic-memory-local

The marketplace entry points at ./plugins/codex, resolved relative to the repository root.

First-Time Setup

From the repository root:

codex plugin marketplace add "$(git rev-parse --show-toplevel)"
codex plugin add codex@basic-memory-local

Start a new Codex thread after installing. New threads are the reliable boundary for picking up plugin skills, hooks, and MCP configuration.

Plugin installation is user-level in Codex, so one install makes the plugin available across projects on the same machine. Repo-specific memory routing still comes from each checkout's .codex/basic-memory.json.

Iteration Loop

After changing files in plugins/codex, run the local checks:

just package-check-codex

Then update the manifest cachebuster and reinstall from the local marketplace:

python3 "$CODEX_PLUGIN_CREATOR_SCRIPTS/update_plugin_cachebuster.py" \
  "$(git rev-parse --show-toplevel)/plugins/codex"
codex plugin add codex@basic-memory-local

Start a fresh Codex thread to test the updated plugin.

Useful Checks

List configured marketplaces:

codex plugin marketplace list

List plugins Codex can see:

codex plugin list

Run the full package validation gate when touching plugin packaging, shared skills, or integration metadata:

just package-check

To also run Codex's scaffold validator during just package-check-codex, set CODEX_PLUGIN_VALIDATOR to the local plugin-creator validator script before running the check.