feat(v1.1): consolidate 29 tools → 8 unified tools + CLI

Tool Consolidation:
- search: merges recall, semantic_search, hybrid_search
- memory: merges get_knowledge, delete_knowledge, get_memory_state
- codebase: merges remember_pattern, remember_decision, get_codebase_context
- intention: merges all 5 intention tools into action-based API

New CLI Binary:
- vestige stats [--tagging] [--states]
- vestige health
- vestige consolidate
- vestige restore <file>

Documentation:
- Verify all neuroscience claims against codebase
- Fix Memory States table: "Retention" → "Accessibility" with formula
- Clarify Spreading Activation: embedding similarity vs full network module
- Update Synaptic Tagging: clarify 9h/2h implementation vs biology
- Add comprehensive FAQ with 30+ questions
- Add storage modes: global, per-project, multi-Claude household
- Add CLAUDE.md setup instructions

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Sam Valladares 2026-01-26 01:31:58 -06:00
parent 29130c3068
commit 8bb6500985
11 changed files with 4152 additions and 90 deletions

View file

@ -0,0 +1,436 @@
//! Vestige CLI
//!
//! Command-line interface for managing cognitive memory system.
use std::path::PathBuf;
use clap::{Parser, Subcommand};
use colored::Colorize;
use vestige_core::{IngestInput, Storage};
/// Vestige - Cognitive Memory System CLI
#[derive(Parser)]
#[command(name = "vestige")]
#[command(author = "samvallad33")]
#[command(version = "1.0.0")]
#[command(about = "CLI for the Vestige cognitive memory system")]
#[command(long_about = "Vestige is a cognitive memory system based on 130 years of memory research.\n\nIt implements FSRS-6, spreading activation, synaptic tagging, and more.")]
struct Cli {
#[command(subcommand)]
command: Commands,
}
#[derive(Subcommand)]
enum Commands {
/// Show memory statistics
Stats {
/// Show tagging/retention distribution
#[arg(long)]
tagging: bool,
/// Show cognitive state distribution
#[arg(long)]
states: bool,
},
/// Run health check with warnings and recommendations
Health,
/// Run memory consolidation cycle
Consolidate,
/// Restore memories from backup file
Restore {
/// Path to backup JSON file
file: PathBuf,
},
}
fn main() -> anyhow::Result<()> {
let cli = Cli::parse();
match cli.command {
Commands::Stats { tagging, states } => run_stats(tagging, states),
Commands::Health => run_health(),
Commands::Consolidate => run_consolidate(),
Commands::Restore { file } => run_restore(file),
}
}
/// Run stats command
fn run_stats(show_tagging: bool, show_states: bool) -> anyhow::Result<()> {
let storage = Storage::new(None)?;
let stats = storage.get_stats()?;
println!("{}", "=== Vestige Memory Statistics ===".cyan().bold());
println!();
// Basic stats
println!("{}: {}", "Total Memories".white().bold(), stats.total_nodes);
println!("{}: {}", "Due for Review".white().bold(), stats.nodes_due_for_review);
println!("{}: {:.1}%", "Average Retention".white().bold(), stats.average_retention * 100.0);
println!("{}: {:.2}", "Average Storage Strength".white().bold(), stats.average_storage_strength);
println!("{}: {:.2}", "Average Retrieval Strength".white().bold(), stats.average_retrieval_strength);
println!("{}: {}", "With Embeddings".white().bold(), stats.nodes_with_embeddings);
if let Some(model) = &stats.embedding_model {
println!("{}: {}", "Embedding Model".white().bold(), model);
}
if let Some(oldest) = stats.oldest_memory {
println!("{}: {}", "Oldest Memory".white().bold(), oldest.format("%Y-%m-%d %H:%M:%S"));
}
if let Some(newest) = stats.newest_memory {
println!("{}: {}", "Newest Memory".white().bold(), newest.format("%Y-%m-%d %H:%M:%S"));
}
// Embedding coverage
let embedding_coverage = if stats.total_nodes > 0 {
(stats.nodes_with_embeddings as f64 / stats.total_nodes as f64) * 100.0
} else {
0.0
};
println!("{}: {:.1}%", "Embedding Coverage".white().bold(), embedding_coverage);
// Tagging distribution (retention levels)
if show_tagging {
println!();
println!("{}", "=== Retention Distribution ===".yellow().bold());
let memories = storage.get_all_nodes(500, 0)?;
let total = memories.len();
if total > 0 {
let high = memories.iter().filter(|m| m.retention_strength >= 0.7).count();
let medium = memories.iter().filter(|m| m.retention_strength >= 0.4 && m.retention_strength < 0.7).count();
let low = memories.iter().filter(|m| m.retention_strength < 0.4).count();
print_distribution_bar("High (>=70%)", high, total, "green");
print_distribution_bar("Medium (40-70%)", medium, total, "yellow");
print_distribution_bar("Low (<40%)", low, total, "red");
} else {
println!("{}", "No memories found.".dimmed());
}
}
// State distribution
if show_states {
println!();
println!("{}", "=== Cognitive State Distribution ===".magenta().bold());
let memories = storage.get_all_nodes(500, 0)?;
let total = memories.len();
if total > 0 {
let (active, dormant, silent, unavailable) = compute_state_distribution(&memories);
print_distribution_bar("Active", active, total, "green");
print_distribution_bar("Dormant", dormant, total, "yellow");
print_distribution_bar("Silent", silent, total, "red");
print_distribution_bar("Unavailable", unavailable, total, "magenta");
println!();
println!("{}", "State Thresholds:".dimmed());
println!(" {} >= 0.70 accessibility", "Active".green());
println!(" {} >= 0.40 accessibility", "Dormant".yellow());
println!(" {} >= 0.10 accessibility", "Silent".red());
println!(" {} < 0.10 accessibility", "Unavailable".magenta());
} else {
println!("{}", "No memories found.".dimmed());
}
}
Ok(())
}
/// Compute cognitive state distribution for memories
fn compute_state_distribution(memories: &[vestige_core::KnowledgeNode]) -> (usize, usize, usize, usize) {
let mut active = 0;
let mut dormant = 0;
let mut silent = 0;
let mut unavailable = 0;
for memory in memories {
// Accessibility = 0.5*retention + 0.3*retrieval + 0.2*storage
let accessibility = memory.retention_strength * 0.5
+ memory.retrieval_strength * 0.3
+ memory.storage_strength * 0.2;
if accessibility >= 0.7 {
active += 1;
} else if accessibility >= 0.4 {
dormant += 1;
} else if accessibility >= 0.1 {
silent += 1;
} else {
unavailable += 1;
}
}
(active, dormant, silent, unavailable)
}
/// Print a distribution bar
fn print_distribution_bar(label: &str, count: usize, total: usize, color: &str) {
let percentage = if total > 0 {
(count as f64 / total as f64) * 100.0
} else {
0.0
};
let bar_width: usize = 30;
let filled = ((percentage / 100.0) * bar_width as f64) as usize;
let empty = bar_width.saturating_sub(filled);
let bar = format!("{}{}", "#".repeat(filled), "-".repeat(empty));
let colored_bar = match color {
"green" => bar.green(),
"yellow" => bar.yellow(),
"red" => bar.red(),
"magenta" => bar.magenta(),
_ => bar.white(),
};
println!(
" {:15} [{:30}] {:>4} ({:>5.1}%)",
label,
colored_bar,
count,
percentage
);
}
/// Run health check
fn run_health() -> anyhow::Result<()> {
let storage = Storage::new(None)?;
let stats = storage.get_stats()?;
println!("{}", "=== Vestige Health Check ===".cyan().bold());
println!();
// Determine health status
let (status, status_color) = if stats.total_nodes == 0 {
("EMPTY", "white")
} else if stats.average_retention < 0.3 {
("CRITICAL", "red")
} else if stats.average_retention < 0.5 {
("DEGRADED", "yellow")
} else {
("HEALTHY", "green")
};
let colored_status = match status_color {
"green" => status.green().bold(),
"yellow" => status.yellow().bold(),
"red" => status.red().bold(),
_ => status.white().bold(),
};
println!("{}: {}", "Status".white().bold(), colored_status);
println!("{}: {}", "Total Memories".white(), stats.total_nodes);
println!("{}: {}", "Due for Review".white(), stats.nodes_due_for_review);
println!("{}: {:.1}%", "Average Retention".white(), stats.average_retention * 100.0);
// Embedding coverage
let embedding_coverage = if stats.total_nodes > 0 {
(stats.nodes_with_embeddings as f64 / stats.total_nodes as f64) * 100.0
} else {
0.0
};
println!("{}: {:.1}%", "Embedding Coverage".white(), embedding_coverage);
println!("{}: {}", "Embedding Service".white(),
if storage.is_embedding_ready() { "Ready".green() } else { "Not Ready".red() });
// Warnings
let mut warnings = Vec::new();
if stats.average_retention < 0.5 && stats.total_nodes > 0 {
warnings.push("Low average retention - consider running consolidation or reviewing memories");
}
if stats.nodes_due_for_review > 10 {
warnings.push("Many memories are due for review");
}
if stats.total_nodes > 0 && stats.nodes_with_embeddings == 0 {
warnings.push("No embeddings generated - semantic search unavailable");
}
if embedding_coverage < 50.0 && stats.total_nodes > 10 {
warnings.push("Low embedding coverage - run consolidation to improve semantic search");
}
if !warnings.is_empty() {
println!();
println!("{}", "Warnings:".yellow().bold());
for warning in &warnings {
println!(" {} {}", "!".yellow().bold(), warning.yellow());
}
}
// Recommendations
let mut recommendations = Vec::new();
if status == "CRITICAL" {
recommendations.push("CRITICAL: Many memories have very low retention. Review important memories.");
}
if stats.nodes_due_for_review > 5 {
recommendations.push("Review due memories to strengthen retention.");
}
if stats.nodes_with_embeddings < stats.total_nodes {
recommendations.push("Run 'vestige consolidate' to generate embeddings for better semantic search.");
}
if stats.total_nodes > 100 && stats.average_retention < 0.7 {
recommendations.push("Consider running periodic consolidation to maintain memory health.");
}
if recommendations.is_empty() && status == "HEALTHY" {
recommendations.push("Memory system is healthy!");
}
println!();
println!("{}", "Recommendations:".cyan().bold());
for rec in &recommendations {
let icon = if rec.starts_with("CRITICAL") { "!".red().bold() } else { ">".cyan() };
let text = if rec.starts_with("CRITICAL") { rec.red().to_string() } else { rec.to_string() };
println!(" {} {}", icon, text);
}
Ok(())
}
/// Run consolidation cycle
fn run_consolidate() -> anyhow::Result<()> {
println!("{}", "=== Vestige Consolidation ===".cyan().bold());
println!();
println!("Running memory consolidation cycle...");
println!();
let mut storage = Storage::new(None)?;
let result = storage.run_consolidation()?;
println!("{}: {}", "Nodes Processed".white().bold(), result.nodes_processed);
println!("{}: {}", "Nodes Promoted".white().bold(), result.nodes_promoted);
println!("{}: {}", "Nodes Pruned".white().bold(), result.nodes_pruned);
println!("{}: {}", "Decay Applied".white().bold(), result.decay_applied);
println!("{}: {}", "Embeddings Generated".white().bold(), result.embeddings_generated);
println!("{}: {}ms", "Duration".white().bold(), result.duration_ms);
println!();
println!(
"{}",
format!(
"Consolidation complete: {} nodes processed, {} embeddings generated in {}ms",
result.nodes_processed, result.embeddings_generated, result.duration_ms
)
.green()
);
Ok(())
}
/// Run restore from backup
fn run_restore(backup_path: PathBuf) -> anyhow::Result<()> {
println!("{}", "=== Vestige Restore ===".cyan().bold());
println!();
println!("Loading backup from: {}", backup_path.display());
// Read and parse backup
let backup_content = std::fs::read_to_string(&backup_path)?;
#[derive(serde::Deserialize)]
struct BackupWrapper {
#[serde(rename = "type")]
_type: String,
text: String,
}
#[derive(serde::Deserialize)]
struct RecallResult {
results: Vec<MemoryBackup>,
}
#[derive(serde::Deserialize)]
#[serde(rename_all = "camelCase")]
struct MemoryBackup {
content: String,
node_type: Option<String>,
tags: Option<Vec<String>>,
source: Option<String>,
}
let wrapper: Vec<BackupWrapper> = serde_json::from_str(&backup_content)?;
let recall_result: RecallResult = serde_json::from_str(&wrapper[0].text)?;
let memories = recall_result.results;
println!("Found {} memories to restore", memories.len());
println!();
// Initialize storage
println!("Initializing storage...");
let mut storage = Storage::new(None)?;
println!("Generating embeddings and ingesting memories...");
println!();
let total = memories.len();
let mut success_count = 0;
for (i, memory) in memories.into_iter().enumerate() {
let input = IngestInput {
content: memory.content.clone(),
node_type: memory.node_type.unwrap_or_else(|| "fact".to_string()),
source: memory.source,
sentiment_score: 0.0,
sentiment_magnitude: 0.0,
tags: memory.tags.unwrap_or_default(),
valid_from: None,
valid_until: None,
};
match storage.ingest(input) {
Ok(_node) => {
success_count += 1;
println!(
"[{}/{}] {} {}",
i + 1,
total,
"OK".green(),
truncate(&memory.content, 60)
);
}
Err(e) => {
println!("[{}/{}] {} {}", i + 1, total, "FAIL".red(), e);
}
}
}
println!();
println!(
"Restore complete: {}/{} memories restored",
success_count.to_string().green().bold(),
total
);
// Show stats
let stats = storage.get_stats()?;
println!();
println!("{}: {}", "Total Nodes".white(), stats.total_nodes);
println!("{}: {}", "With Embeddings".white(), stats.nodes_with_embeddings);
Ok(())
}
/// Truncate a string for display (UTF-8 safe)
fn truncate(s: &str, max_chars: usize) -> String {
let s = s.replace('\n', " ");
if s.chars().count() <= max_chars {
s
} else {
let truncated: String = s.chars().take(max_chars).collect();
format!("{}...", truncated)
}
}

View file

@ -83,11 +83,13 @@ fn main() -> anyhow::Result<()> {
Ok(())
}
fn truncate(s: &str, max_len: usize) -> String {
/// Truncate a string for display (UTF-8 safe)
fn truncate(s: &str, max_chars: usize) -> String {
let s = s.replace('\n', " ");
if s.len() <= max_len {
if s.chars().count() <= max_chars {
s
} else {
format!("{}...", &s[..max_len])
let truncated: String = s.chars().take(max_chars).collect();
format!("{}...", truncated)
}
}