* feat(codex): add Hindsight memory integration for OpenAI Codex CLI
Hooks-based integration that gives Codex CLI long-term memory via Hindsight.
Three hooks keep memory in sync: SessionStart (daemon pre-warm), UserPromptSubmit
(recall + context injection), Stop (retain conversation to memory).
Key differences from the Claude Code integration:
- Codex transcript format: JSONL with {msg: {type, message}} (user_message/agent_message)
- No CODEX_PLUGIN_ROOT env var — install.sh writes hooks.json with absolute paths
- State stored in ~/.hindsight/codex/state/ (not CLAUDE_PLUGIN_DATA)
- No async: true in hooks (not supported by Codex)
- No SessionEnd event
- hooks.json written to ~/.codex/hooks.json with codex_hooks = true in config.toml
* fix(codex): fix transcript parser for actual Codex disk format
Codex stores sessions as rollout-*.jsonl with response_item entries:
User: {type:response_item, payload:{type:message, role:user, content:[{type:input_text, text:...}]}}
Assistant: {type:response_item, payload:{type:message, role:assistant, phase:final_answer, content:[{type:output_text, text:...}]}}
Previous parser expected an undocumented {msg:{type:user_message}} format from the Rust protocol spec
that does not match the actual on-disk storage format.
* feat(codex): add reflect mode to UserPromptSubmit hook
Add recallMode config option (default: 'recall') that switches the
UserPromptSubmit hook between:
- 'recall': existing behavior, fast raw facts list
- 'reflect': agentic synthesis loop, returns coherent prose answer
Also adds reflect() method to HindsightClient and HINDSIGHT_RECALL_MODE
env var override. Reflect uses a 25s timeout (vs 10s for recall).
* feat(codex): auto mode for recall/reflect selection
Add recallMode: 'auto' (new default) that picks the operation per-query:
- Synthesis patterns (what do you know, what's my, summarize, etc.) → reflect
- All other prompts → recall (fast, raw facts, better for code tasks)
* feat(codex): add automated test suite and finalize recall-only mode
* docs(codex): add docs page and sidebar entry for Codex CLI integration
143 lines
4.8 KiB
Python
143 lines
4.8 KiB
Python
"""Configuration management for Hindsight Codex plugin.
|
|
|
|
Loads settings from settings.json (plugin defaults) merged with environment
|
|
variable overrides. Full config schema matching Openclaw's 30+ options.
|
|
"""
|
|
|
|
import json
|
|
import os
|
|
import sys
|
|
|
|
DEFAULTS = {
|
|
# Recall
|
|
"autoRecall": True,
|
|
"recallBudget": "mid",
|
|
"recallMaxTokens": 1024,
|
|
"recallTypes": ["world", "experience"],
|
|
"recallContextTurns": 1,
|
|
"recallMaxQueryChars": 800,
|
|
"recallRoles": ["user", "assistant"],
|
|
"recallPromptPreamble": (
|
|
"Relevant memories from past conversations (prioritize recent when "
|
|
"conflicting). Only use memories that are directly useful to continue "
|
|
"this conversation; ignore the rest:"
|
|
),
|
|
# Retain
|
|
"autoRetain": True,
|
|
"retainMode": "full-session",
|
|
"retainRoles": ["user", "assistant"],
|
|
"retainEveryNTurns": 10,
|
|
"retainOverlapTurns": 2,
|
|
"retainToolCalls": True,
|
|
"retainContext": "codex",
|
|
"retainTags": [],
|
|
"retainMetadata": {},
|
|
# Connection
|
|
"hindsightApiUrl": None,
|
|
"hindsightApiToken": None,
|
|
"apiPort": 9077,
|
|
"daemonIdleTimeout": 0,
|
|
"embedVersion": "latest",
|
|
"embedPackagePath": None,
|
|
# Bank
|
|
"bankId": None,
|
|
"bankIdPrefix": "",
|
|
"dynamicBankId": False,
|
|
"dynamicBankGranularity": ["agent", "project"],
|
|
"bankMission": "",
|
|
"retainMission": None,
|
|
"agentName": "codex",
|
|
# LLM (for daemon mode)
|
|
"llmProvider": None,
|
|
"llmModel": None,
|
|
"llmApiKeyEnv": None,
|
|
# Misc
|
|
"debug": False,
|
|
}
|
|
|
|
# Map env var names to config keys and their types
|
|
ENV_OVERRIDES = {
|
|
"HINDSIGHT_API_URL": ("hindsightApiUrl", str),
|
|
"HINDSIGHT_API_TOKEN": ("hindsightApiToken", str),
|
|
"HINDSIGHT_BANK_ID": ("bankId", str),
|
|
"HINDSIGHT_AGENT_NAME": ("agentName", str),
|
|
"HINDSIGHT_AUTO_RECALL": ("autoRecall", bool),
|
|
"HINDSIGHT_AUTO_RETAIN": ("autoRetain", bool),
|
|
"HINDSIGHT_RETAIN_MODE": ("retainMode", str),
|
|
"HINDSIGHT_RECALL_BUDGET": ("recallBudget", str),
|
|
"HINDSIGHT_RECALL_MAX_TOKENS": ("recallMaxTokens", int),
|
|
"HINDSIGHT_RECALL_MAX_QUERY_CHARS": ("recallMaxQueryChars", int),
|
|
"HINDSIGHT_RECALL_CONTEXT_TURNS": ("recallContextTurns", int),
|
|
"HINDSIGHT_API_PORT": ("apiPort", int),
|
|
"HINDSIGHT_DAEMON_IDLE_TIMEOUT": ("daemonIdleTimeout", int),
|
|
"HINDSIGHT_EMBED_VERSION": ("embedVersion", str),
|
|
"HINDSIGHT_EMBED_PACKAGE_PATH": ("embedPackagePath", str),
|
|
"HINDSIGHT_DYNAMIC_BANK_ID": ("dynamicBankId", bool),
|
|
"HINDSIGHT_BANK_MISSION": ("bankMission", str),
|
|
"HINDSIGHT_LLM_PROVIDER": ("llmProvider", str),
|
|
"HINDSIGHT_LLM_MODEL": ("llmModel", str),
|
|
"HINDSIGHT_DEBUG": ("debug", bool),
|
|
}
|
|
|
|
|
|
def _cast_env(value: str, typ):
|
|
"""Cast environment variable string to target type. Returns None on failure."""
|
|
try:
|
|
if typ is bool:
|
|
return value.lower() in ("true", "1", "yes")
|
|
if typ is int:
|
|
return int(value)
|
|
return value
|
|
except (ValueError, AttributeError):
|
|
return None
|
|
|
|
|
|
def _load_settings_file(path: str, config: dict) -> None:
|
|
"""Merge a settings.json file into config in-place. Silently skips if missing."""
|
|
if not os.path.exists(path):
|
|
return
|
|
try:
|
|
with open(path) as f:
|
|
file_config = json.load(f)
|
|
config.update({k: v for k, v in file_config.items() if v is not None})
|
|
except (json.JSONDecodeError, OSError) as e:
|
|
debug_log(config, f"Failed to load {path}: {e}")
|
|
|
|
|
|
def load_config() -> dict:
|
|
"""Load plugin configuration from settings.json + env overrides.
|
|
|
|
Loading order (later entries win):
|
|
1. Built-in defaults
|
|
2. Plugin install settings.json (~/.hindsight/codex/settings.json)
|
|
3. User config (~/.hindsight/codex.json)
|
|
4. Environment variable overrides
|
|
|
|
~/.hindsight/codex.json is the recommended place to configure the
|
|
plugin — stable across updates.
|
|
"""
|
|
config = dict(DEFAULTS)
|
|
|
|
# 1. Plugin install settings.json (written by install.sh)
|
|
install_root = os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
|
_load_settings_file(os.path.join(install_root, "settings.json"), config)
|
|
|
|
# 2. User config — stable, version-independent
|
|
user_config_path = os.path.join(os.path.expanduser("~"), ".hindsight", "codex.json")
|
|
_load_settings_file(user_config_path, config)
|
|
|
|
# Apply environment variable overrides
|
|
for env_name, (key, typ) in ENV_OVERRIDES.items():
|
|
val = os.environ.get(env_name)
|
|
if val is not None:
|
|
cast_val = _cast_env(val, typ)
|
|
if cast_val is not None:
|
|
config[key] = cast_val
|
|
|
|
return config
|
|
|
|
|
|
def debug_log(config: dict, *args):
|
|
"""Log to stderr if debug mode is enabled."""
|
|
if config.get("debug"):
|
|
print("[Hindsight]", *args, file=sys.stderr)
|