* 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
165 lines
4.9 KiB
Python
Executable file
165 lines
4.9 KiB
Python
Executable file
#!/usr/bin/env python3
|
|
"""Auto-recall hook for UserPromptSubmit.
|
|
|
|
Fires before each user prompt. Retrieves relevant memories from Hindsight
|
|
and injects them into the Codex context via hookSpecificOutput.additionalContext.
|
|
|
|
Flow:
|
|
1. Read hook input from stdin (session_id, transcript_path, prompt/user_prompt)
|
|
2. Resolve API URL
|
|
3. Derive bank ID and ensure mission
|
|
4. Compose multi-turn query if recallContextTurns > 1
|
|
5. Truncate to recallMaxQueryChars
|
|
6. Call Hindsight recall API
|
|
7. Format memories and output hookSpecificOutput.additionalContext
|
|
|
|
Exit codes:
|
|
0 — always (graceful degradation on any error)
|
|
"""
|
|
|
|
import json
|
|
import os
|
|
import sys
|
|
import time
|
|
|
|
sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
|
|
|
|
from lib.bank import derive_bank_id, ensure_bank_mission
|
|
from lib.client import HindsightClient
|
|
from lib.config import debug_log, load_config
|
|
from lib.content import (
|
|
compose_recall_query,
|
|
format_current_time,
|
|
format_memories,
|
|
read_transcript,
|
|
truncate_recall_query,
|
|
)
|
|
from lib.daemon import get_api_url
|
|
from lib.state import write_state
|
|
|
|
LAST_RECALL_STATE = "last_recall.json"
|
|
|
|
|
|
def main():
|
|
config = load_config()
|
|
|
|
if not config.get("autoRecall"):
|
|
debug_log(config, "Auto-recall disabled, exiting")
|
|
return
|
|
|
|
# Read hook input from stdin
|
|
try:
|
|
hook_input = json.load(sys.stdin)
|
|
except (json.JSONDecodeError, EOFError):
|
|
print("[Hindsight] Failed to read hook input", file=sys.stderr)
|
|
return
|
|
|
|
debug_log(config, f"Hook input keys: {list(hook_input.keys())}")
|
|
|
|
# Extract user query — accept both "prompt" and "user_prompt" defensively
|
|
prompt = (hook_input.get("prompt") or hook_input.get("user_prompt") or "").strip()
|
|
if not prompt or len(prompt) < 5:
|
|
debug_log(config, "Prompt too short for recall, skipping")
|
|
return
|
|
|
|
def _dbg(*a):
|
|
debug_log(config, *a)
|
|
|
|
try:
|
|
api_url = get_api_url(config, debug_fn=_dbg, allow_daemon_start=False)
|
|
except RuntimeError as e:
|
|
print(f"[Hindsight] {e}", file=sys.stderr)
|
|
return
|
|
|
|
api_token = config.get("hindsightApiToken")
|
|
try:
|
|
client = HindsightClient(api_url, api_token)
|
|
except ValueError as e:
|
|
print(f"[Hindsight] Invalid API URL: {e}", file=sys.stderr)
|
|
return
|
|
|
|
bank_id = derive_bank_id(hook_input, config)
|
|
ensure_bank_mission(client, bank_id, config, debug_fn=_dbg)
|
|
|
|
# Multi-turn query composition
|
|
recall_context_turns = config.get("recallContextTurns", 1)
|
|
recall_max_query_chars = config.get("recallMaxQueryChars", 800)
|
|
recall_roles = config.get("recallRoles", ["user", "assistant"])
|
|
|
|
if recall_context_turns > 1:
|
|
transcript_path = hook_input.get("transcript_path", "")
|
|
messages = read_transcript(transcript_path)
|
|
debug_log(config, f"Multi-turn context: {recall_context_turns} turns, {len(messages)} messages")
|
|
query = compose_recall_query(prompt, messages, recall_context_turns, recall_roles)
|
|
else:
|
|
query = prompt
|
|
|
|
query = truncate_recall_query(query, prompt, recall_max_query_chars)
|
|
if len(query) > recall_max_query_chars:
|
|
query = query[:recall_max_query_chars]
|
|
|
|
current_time = format_current_time()
|
|
preamble = config.get("recallPromptPreamble", "")
|
|
|
|
debug_log(config, f"Recalling from bank '{bank_id}', query length: {len(query)}")
|
|
try:
|
|
response = client.recall(
|
|
bank_id=bank_id,
|
|
query=query,
|
|
max_tokens=config.get("recallMaxTokens", 1024),
|
|
budget=config.get("recallBudget", "mid"),
|
|
types=config.get("recallTypes"),
|
|
timeout=10,
|
|
)
|
|
except Exception as e:
|
|
print(f"[Hindsight] Recall failed: {e}", file=sys.stderr)
|
|
return
|
|
|
|
results = response.get("results", [])
|
|
if not results:
|
|
debug_log(config, "No memories found")
|
|
return
|
|
|
|
debug_log(config, f"Injecting {len(results)} memories")
|
|
|
|
memories_formatted = format_memories(results)
|
|
|
|
context_message = (
|
|
f"<hindsight_memories>\n"
|
|
f"{preamble}\n"
|
|
f"Current time - {current_time}\n\n"
|
|
f"{memories_formatted}\n"
|
|
f"</hindsight_memories>"
|
|
)
|
|
|
|
write_state(
|
|
LAST_RECALL_STATE,
|
|
{
|
|
"context": context_message,
|
|
"saved_at": time.strftime("%Y-%m-%dT%H:%M:%SZ", time.gmtime()),
|
|
"bank_id": bank_id,
|
|
"result_count": len(results),
|
|
},
|
|
)
|
|
|
|
# Output JSON for Codex hook system
|
|
output = {
|
|
"hookSpecificOutput": {
|
|
"hookEventName": "UserPromptSubmit",
|
|
"additionalContext": context_message,
|
|
}
|
|
}
|
|
json.dump(output, sys.stdout)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
try:
|
|
main()
|
|
except Exception as e:
|
|
print(f"[Hindsight] Unexpected error in recall: {e}", file=sys.stderr)
|
|
try:
|
|
from lib.config import load_config
|
|
|
|
sys.exit(2 if load_config().get("debug") else 0)
|
|
except Exception:
|
|
sys.exit(0)
|