recall-echo 3.13.0

Persistent memory system with knowledge graph — for any LLM tool
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
//! Initialize the recall-echo memory system.
//!
//! Creates the directory structure and template files needed for
//! four-layer memory (graph, curated, short-term, long-term), hooks, and LLM provider config.

use std::fs;
use std::io::{self, BufRead, Write as _};
use std::path::Path;

use crate::config::{self, Config, LlmSection, Provider};
use crate::error::RecallError;
use crate::paths;

// ANSI color helpers
const GREEN: &str = "\x1b[32m";
const YELLOW: &str = "\x1b[33m";
const RED: &str = "\x1b[31m";
const BOLD: &str = "\x1b[1m";
const DIM: &str = "\x1b[2m";
const RESET: &str = "\x1b[0m";

const MEMORY_TEMPLATE: &str = "# Memory\n\n\
<!-- recall-echo: Curated memory. Distilled facts, preferences, patterns. -->\n\
<!-- Keep under 200 lines. Only write confirmed, stable information. -->\n";

const ARCHIVE_TEMPLATE: &str = "# Conversation Archive\n\n\
| # | Date | Session | Topics | Messages | Duration |\n\
|---|------|---------|--------|----------|----------|\n";

enum Status {
    Created,
    Exists,
    Error,
}

fn print_status(status: Status, msg: &str) {
    match status {
        Status::Created => eprintln!("  {GREEN}{RESET} {msg}"),
        Status::Exists => eprintln!("  {YELLOW}~{RESET} {msg}"),
        Status::Error => eprintln!("  {RED}{RESET} {msg}"),
    }
}

fn ensure_dir(path: &Path) {
    if !path.exists() {
        if let Err(e) = fs::create_dir_all(path) {
            print_status(
                Status::Error,
                &format!("Failed to create {}: {e}", path.display()),
            );
        }
    }
}

fn write_if_not_exists(path: &Path, content: &str, label: &str) {
    if path.exists() {
        print_status(
            Status::Exists,
            &format!("{label} already exists — preserved"),
        );
    } else {
        match fs::write(path, content) {
            Ok(()) => print_status(Status::Created, &format!("Created {label}")),
            Err(e) => print_status(Status::Error, &format!("Failed to create {label}: {e}")),
        }
    }
}

/// Prompt for LLM provider selection during init.
/// Returns None if stdin is not a terminal (non-interactive).
fn prompt_provider(reader: &mut dyn BufRead) -> Option<Provider> {
    // Check if stdin is a terminal
    if !atty_check() {
        // Non-interactive: default to claude-code if detected, else anthropic
        return if paths::detect_claude_code().is_some() {
            Some(Provider::ClaudeCode)
        } else {
            Some(Provider::Anthropic)
        };
    }

    let is_cc = paths::detect_claude_code().is_some();
    let default_label = if is_cc { "3" } else { "1" };

    eprintln!("\n{BOLD}LLM provider for entity extraction:{RESET}");
    eprintln!(
        "  {BOLD}1{RESET}) anthropic   {DIM}— Claude API{}",
        if !is_cc { " (default)" } else { "" }
    );
    eprintln!("  {BOLD}2{RESET}) ollama      {DIM}— Local models via Ollama{RESET}");
    eprintln!(
        "  {BOLD}3{RESET}) claude-code {DIM}— Uses `claude -p` subprocess{}",
        if is_cc { " (default)" } else { "" }
    );
    eprintln!(
        "  {BOLD}4{RESET}) skip        {DIM}— Configure later with `recall-echo config`{RESET}"
    );
    eprint!("\n  Choice [{default_label}]: ");
    io::stderr().flush().ok();

    let mut input = String::new();
    if reader.read_line(&mut input).is_err() {
        return None;
    }

    match input.trim() {
        "" => {
            if is_cc {
                Some(Provider::ClaudeCode)
            } else {
                Some(Provider::Anthropic)
            }
        }
        "1" | "anthropic" => Some(Provider::Anthropic),
        "2" | "ollama" => Some(Provider::Openai),
        "3" | "claude-code" => Some(Provider::ClaudeCode),
        "4" | "skip" => None,
        _ => {
            let default = if is_cc {
                Provider::ClaudeCode
            } else {
                Provider::Anthropic
            };
            eprintln!("  {YELLOW}~{RESET} Unknown choice, defaulting to {default}");
            Some(default)
        }
    }
}

/// Configure LLM provider. Returns true if the chosen provider is claude-code
/// (indicating this is likely a Claude Code user).
fn configure_llm(reader: &mut dyn BufRead, memory_dir: &Path) -> bool {
    if !config::exists(memory_dir) {
        if let Some(provider) = prompt_provider(reader) {
            let is_cc = provider == Provider::ClaudeCode;
            let cfg = Config {
                llm: LlmSection {
                    provider: provider.clone(),
                    model: String::new(),
                    api_base: String::new(),
                },
                ..Config::default()
            };
            match config::save(memory_dir, &cfg) {
                Ok(()) => {
                    let display_name = match &provider {
                        Provider::Anthropic => "anthropic",
                        Provider::Openai => "ollama (openai-compat)",
                        Provider::ClaudeCode => "claude-code",
                    };
                    print_status(
                        Status::Created,
                        &format!("Created .recall-echo.toml (provider: {display_name})"),
                    );
                }
                Err(e) => print_status(Status::Error, &format!("Failed to write config: {e}")),
            }
            return is_cc;
        }
        print_status(
            Status::Exists,
            "Skipped LLM config — run `recall-echo config set provider <name>` later",
        );
    } else {
        print_status(
            Status::Exists,
            ".recall-echo.toml already exists — preserved",
        );
        // Check existing config
        let cfg = config::load(memory_dir);
        return cfg.llm.provider == Provider::ClaudeCode;
    }
    false
}

/// Initialize the graph store in memory/graph/.
fn init_graph(memory_dir: &Path) {
    let graph_dir = memory_dir.join("graph");
    if graph_dir.exists() {
        print_status(Status::Exists, "graph/ already exists — preserved");
        return;
    }

    let runtime = tokio::runtime::Builder::new_current_thread()
        .enable_all()
        .build();
    match runtime {
        Ok(rt) => match rt.block_on(crate::graph::GraphMemory::open(&graph_dir)) {
            Ok(_) => print_status(
                Status::Created,
                "Created graph/ (SurrealDB; embedding model downloads on first use)",
            ),
            Err(e) => print_status(Status::Error, &format!("Failed to init graph: {e}")),
        },
        Err(e) => print_status(Status::Error, &format!("Failed to start runtime: {e}")),
    }
}

/// Auto-configure Claude Code hooks (settings.json).
/// Returns true if hooks were configured.
/// Hooks always go in ~/.claude/settings.json regardless of where entity_root is.
fn configure_hooks(_entity_root: &Path) -> bool {
    let claude_dir = match paths::detect_claude_code() {
        Some(dir) => dir,
        None => return false,
    };

    let settings_path = claude_dir.join("settings.json");
    let recall_bin = std::env::current_exe()
        .ok()
        .and_then(|p| p.to_str().map(String::from))
        .unwrap_or_else(|| "recall-echo".into());

    let archive_cmd = format!("{recall_bin} archive-session");
    let checkpoint_cmd = format!("{recall_bin} checkpoint --trigger precompact");
    let consume_cmd = format!("{recall_bin} consume");

    // Load existing settings or start fresh
    let mut settings: serde_json::Value = if settings_path.exists() {
        fs::read_to_string(&settings_path)
            .ok()
            .and_then(|s| serde_json::from_str(&s).ok())
            .unwrap_or_else(|| serde_json::json!({}))
    } else {
        serde_json::json!({})
    };

    let hooks = settings.as_object_mut().and_then(|o| {
        o.entry("hooks")
            .or_insert_with(|| serde_json::json!({}))
            .as_object_mut()
    });

    let hooks = match hooks {
        Some(h) => h,
        None => {
            print_status(Status::Error, "Could not parse settings.json hooks");
            return false;
        }
    };

    let mut changed = false;

    // Add SessionStart hook if not already present
    // Fires once per session (on startup or resume) — injects EPHEMERAL.md
    // into context via stdout. Skips `clear` (user reset) and `compact`
    // (we just recovered from a compaction, no prior session to surface).
    if !hook_exists(hooks, "SessionStart", &consume_cmd) {
        let arr = hooks
            .entry("SessionStart")
            .or_insert_with(|| serde_json::json!([]))
            .as_array_mut();
        if let Some(arr) = arr {
            arr.push(serde_json::json!({
                "matcher": "startup|resume",
                "hooks": [{"type": "command", "command": consume_cmd}]
            }));
            changed = true;
        }
    }

    // Add SessionEnd hook if not already present
    if !hook_exists(hooks, "SessionEnd", &archive_cmd) {
        let arr = hooks
            .entry("SessionEnd")
            .or_insert_with(|| serde_json::json!([]))
            .as_array_mut();
        if let Some(arr) = arr {
            arr.push(serde_json::json!({
                "hooks": [{"type": "command", "command": archive_cmd}]
            }));
            changed = true;
        }
    }

    // Add PreCompact hook if not already present
    if !hook_exists(hooks, "PreCompact", &checkpoint_cmd) {
        let arr = hooks
            .entry("PreCompact")
            .or_insert_with(|| serde_json::json!([]))
            .as_array_mut();
        if let Some(arr) = arr {
            arr.push(serde_json::json!({
                "hooks": [{"type": "command", "command": checkpoint_cmd}]
            }));
            changed = true;
        }
    }

    if changed {
        match serde_json::to_string_pretty(&settings) {
            Ok(content) => match fs::write(&settings_path, content) {
                Ok(()) => {
                    print_status(
                        Status::Created,
                        "Configured SessionStart + SessionEnd + PreCompact hooks in settings.json",
                    );
                    return true;
                }
                Err(e) => print_status(
                    Status::Error,
                    &format!("Failed to write settings.json: {e}"),
                ),
            },
            Err(e) => print_status(Status::Error, &format!("Failed to serialize settings: {e}")),
        }
    } else {
        print_status(Status::Exists, "Hooks already configured in settings.json");
        return true;
    }

    false
}

/// Check if a hook command already exists in a hook event array.
fn hook_exists(
    hooks: &serde_json::Map<String, serde_json::Value>,
    event: &str,
    command: &str,
) -> bool {
    if let Some(arr) = hooks.get(event).and_then(|v| v.as_array()) {
        for group in arr {
            if let Some(inner) = group.get("hooks").and_then(|h| h.as_array()) {
                for hook in inner {
                    if let Some(cmd) = hook.get("command").and_then(|c| c.as_str()) {
                        // Match on the base command name, not the full path
                        if cmd.contains("recall-echo archive-session")
                            && command.contains("archive-session")
                        {
                            return true;
                        }
                        if cmd.contains("recall-echo checkpoint") && command.contains("checkpoint")
                        {
                            return true;
                        }
                        if cmd.contains("recall-echo consume") && command.contains("consume") {
                            return true;
                        }
                    }
                }
            }
        }
    }
    false
}

/// Check if stderr is a terminal (for interactive prompts).
fn atty_check() -> bool {
    use std::io::IsTerminal;
    std::io::stderr().is_terminal()
}

/// Initialize memory structure at the given entity root.
///
/// Creates:
/// ```text
/// {entity_root}/memory/
/// ├── MEMORY.md
/// ├── EPHEMERAL.md
/// ├── ARCHIVE.md
/// ├── .recall-echo.toml
/// └── conversations/
/// ```
pub fn run(entity_root: &Path) -> Result<(), RecallError> {
    let stdin = io::stdin();
    let mut reader = stdin.lock();
    run_with_reader(entity_root, &mut reader)
}

/// Testable init with injectable reader.
pub fn run_with_reader(entity_root: &Path, reader: &mut dyn BufRead) -> Result<(), RecallError> {
    if !entity_root.exists() {
        return Err(RecallError::NotInitialized(format!(
            "Directory not found: {}\n  Create the directory first, or run from a valid path.",
            entity_root.display()
        )));
    }

    eprintln!("\n{BOLD}recall-echo{RESET} — initializing memory system\n");

    let memory_dir = entity_root.join("memory");
    let conversations_dir = memory_dir.join("conversations");
    ensure_dir(&memory_dir);
    ensure_dir(&conversations_dir);

    // Write MEMORY.md (never overwrite)
    write_if_not_exists(&memory_dir.join("MEMORY.md"), MEMORY_TEMPLATE, "MEMORY.md");

    // Write EPHEMERAL.md (never overwrite)
    write_if_not_exists(&memory_dir.join("EPHEMERAL.md"), "", "EPHEMERAL.md");

    // Write ARCHIVE.md (never overwrite)
    write_if_not_exists(
        &memory_dir.join("ARCHIVE.md"),
        ARCHIVE_TEMPLATE,
        "ARCHIVE.md",
    );

    // Initialize graph store
    init_graph(&memory_dir);

    // Configure LLM provider if no config exists yet
    let is_claude_code = configure_llm(reader, &memory_dir);

    // Auto-configure Claude Code hooks if applicable
    let hooks_configured = if is_claude_code {
        configure_hooks(entity_root)
    } else {
        false
    };

    // Summary
    eprintln!("\n{BOLD}Setup complete.{RESET} Memory system is ready.\n");
    eprintln!("  Layer 1 (MEMORY.md)     — Curated facts, always in context");
    eprintln!("  Layer 2 (EPHEMERAL.md)  — Rolling window of recent sessions (FIFO, max 5)");
    eprintln!("  Layer 3 (Archive)       — Full conversations in memory/conversations/");
    eprintln!("  Layer 0 (Graph)         — Knowledge graph with semantic search");
    eprintln!();
    eprintln!("  Run `recall-echo status` to check memory health.");
    eprintln!("  Run `recall-echo config show` to view configuration.");
    if hooks_configured {
        eprintln!("  Hooks configured — archiving happens automatically.");
    }
    eprintln!();

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::io::Cursor;

    #[test]
    fn init_creates_directories_and_files() {
        let tmp = tempfile::tempdir().unwrap();
        let root = tmp.path().to_path_buf();
        let mut reader = Cursor::new(b"4\n" as &[u8]); // skip provider prompt

        run_with_reader(&root, &mut reader).unwrap();

        assert!(root.join("memory/MEMORY.md").exists());
        assert!(root.join("memory/EPHEMERAL.md").exists());
        assert!(root.join("memory/ARCHIVE.md").exists());
        assert!(root.join("memory/conversations").exists());
    }

    #[test]
    fn init_is_idempotent() {
        let tmp = tempfile::tempdir().unwrap();
        let root = tmp.path().to_path_buf();
        let mut reader = Cursor::new(b"4\n" as &[u8]);

        run_with_reader(&root, &mut reader).unwrap();
        fs::write(root.join("memory/MEMORY.md"), "custom content").unwrap();

        let mut reader2 = Cursor::new(b"4\n" as &[u8]);
        run_with_reader(&root, &mut reader2).unwrap();
        let content = fs::read_to_string(root.join("memory/MEMORY.md")).unwrap();
        assert_eq!(content, "custom content");
    }

    #[test]
    fn init_fails_if_root_missing() {
        let mut reader = Cursor::new(b"" as &[u8]);
        let result = run_with_reader(Path::new("/nonexistent/path"), &mut reader);
        assert!(result.is_err());
    }

    #[test]
    fn hook_exists_recognizes_consume_command() {
        let hooks_json: serde_json::Value = serde_json::json!({
            "SessionStart": [{
                "matcher": "startup|resume",
                "hooks": [{"type": "command", "command": "/usr/local/bin/recall-echo consume"}]
            }]
        });
        let hooks = hooks_json.as_object().unwrap();
        assert!(hook_exists(hooks, "SessionStart", "recall-echo consume"));
        assert!(!hook_exists(hooks, "SessionEnd", "recall-echo consume"));
    }

    #[test]
    fn hook_exists_distinguishes_archive_from_consume() {
        let hooks_json: serde_json::Value = serde_json::json!({
            "SessionEnd": [{
                "hooks": [{"type": "command", "command": "recall-echo archive-session"}]
            }]
        });
        let hooks = hooks_json.as_object().unwrap();
        assert!(hook_exists(
            hooks,
            "SessionEnd",
            "recall-echo archive-session"
        ));
    }

    #[test]
    fn archive_template_has_header() {
        let tmp = tempfile::tempdir().unwrap();
        let mut reader = Cursor::new(b"4\n" as &[u8]);
        run_with_reader(tmp.path(), &mut reader).unwrap();
        let content = fs::read_to_string(tmp.path().join("memory/ARCHIVE.md")).unwrap();
        assert!(content.contains("# Conversation Archive"));
        assert!(content.contains("| # | Date"));
    }
}