Installation¶
Prerequisites¶
- Codex CLI v0.116.0+
- Python 3.10+
- memsearch installed:
uv tool install "memsearch[onnx]"
Install¶
# 1. Clone the memsearch repo (if not already)
git clone https://github.com/zilliztech/memsearch.git
# 2. Run the installer
bash memsearch/plugins/codex/scripts/install.sh
The installer:
- Copies the memory-recall skill to
~/.agents/skills/ - Generates
~/.codex/hooks.jsonwith memsearch hooks - Enables
codex_hooks = truein~/.codex/config.toml - Makes all scripts executable
Usage¶
Why --yolo?
Codex needs --yolo mode on the first run because the ONNX embedding model downloads from HuggingFace Hub (network access required). After the model is cached, --yolo is still needed because hooks execute shell commands.
Pre-cache the Model (optional)¶
Configuration¶
Embedding Provider¶
Default: onnx (bge-m3, CPU, no API key). Change with:
Milvus Backend¶
Default: Milvus Lite (~/.memsearch/milvus.db). For remote Milvus:
Uninstall¶
# Remove hooks
rm ~/.codex/hooks.json
# Remove skill
rm -rf ~/.agents/skills/memory-recall
# Disable hooks in config
# Edit ~/.codex/config.toml and set codex_hooks = false
# Optionally remove memsearch
uv tool uninstall memsearch