Skip to content

Vahlame/obsidian-memory-kit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

159 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Tu agente habla con servidores MCP, que leen y escriben notas Markdown en tu vault git; un daemon opcional sincroniza con un remoto

🧠 Memoria persistente para tu agente de IA

Persistent memory for your AI agent

Tus notas en Markdown + git. El modelo las lee y escribe vía MCP. Todo local, todo tuyo.
Your notes in Markdown + git. The model reads & writes them via MCP. All local, all yours.

MIT Release CI

📖 Léelo en · Read this in:  🇪🇸 Español ·  🇬🇧 English  |  Docs:  🇪🇸 Español ·  🇬🇧 English


¿Qué es esto? · What is this?

🇪🇸 Un kit multiplataforma que le da a la IA (Cursor, Claude Code…) una memoria que sobrevive entre chats: una carpeta de notas Markdown bajo git que el agente lee y escribe a través de MCP (el puente entre el editor y tus archivos). Sin servicio en la nube. La pieza obligatoria es solo el servidor MCP; lo demás (búsqueda semántica, daemon de sync) es opcional.

🇬🇧 A cross-platform kit that gives your AI (Cursor, Claude Code…) memory that survives across chats: a folder of Markdown notes under git that the agent reads and writes through MCP (the bridge between the editor and your files). No cloud service. The only required piece is the MCP server; everything else (semantic search, sync daemon) is optional.

¿Cómo fluye la información? El diagrama de arriba lo resume; el detalle visual está en Cómo funciona · How it works.


Instalación rápida · Quick install

Un comando conecta tu editor a un vault (lo crea si no existe, fusiona mcp.json sin romper otras entradas, hace backup). Sin parámetros = asistente interactivo; con -y no pregunta nada:

npx @vkmikc/create-obsidian-memory                 # asistente interactivo (pre-marca Codex + Claude)
npx @vkmikc/create-obsidian-memory -y              # sin preguntas → ~/Documents/obsidian-memory-vault
npx @vkmikc/create-obsidian-memory "<RUTA>" -y     # sin preguntas, en la ruta que elijas

Todo su potencial, en un solo comando · the whole stack in one command — --full. Enfocado primero en Codex y Claude Code, con todas las funciones activas por defecto · every feature on by default: registra el MCP en ambos, activa la búsqueda híbrida (BM25, semántica y grafo), el grafo de conocimiento (relaciones tipadas y observaciones), los memory reports y la aceleración sqlite-vec, instala el backend Python, construye el índice e instala las reglas — sin preguntas. Córrelo desde un clon del kit (o pásale --repo-root <clon>):

npx @vkmikc/create-obsidian-memory --full          # = --ide codex,claude --with-hybrid --semantic --vec --build-index --install-backend --rules

Si no hay clon a mano, --full no aborta: cae a basic-memory (sin híbrido) y avisa.

¿Prefieres que un agente lo instale? Clónalo y dile «instálalo»: que ejecute npm install y npm run setup — preflight de dependencias → instalación --full → verificación → aviso de reinicio. · Prefer an agent to do it? Clone it and have it run npm install then npm run setup.

🤖 Claude Code / Codex (PC nuevo · fresh PC): --full ya registra el MCP vía claude mcp add / codex mcp add y construye el índice en el mismo comando. Para Claude Code además deja el vault como única memoria: apaga la auto-memoria nativa (autoMemoryEnabled:false) e instala un hook SessionStart del vault (ADR-0029). ¿Solo lo básico? usa --ide codex,claude. Guía completa: 🇪🇸 instalar en PC nueva · 🇬🇧 fresh-PC install.

Luego pega las User Rules y verifica. Los pasos completos (y la verificación) están en la guía:

🇪🇸 Guía de instalación →

o deja que un agente lo instale

🇬🇧 Install guide →

or let an agent install it


Qué incluye · What's inside

Pieza · Piece Lenguaje Rol
packages/create-obsidian-memory/ Node Instalador npx (npm): fusiona el MCP y crea el vault.
packages/obsidian-memory-mcp/ Node MCP "híbrido" (privado; corre desde el clon): tools del vault + búsqueda léxica/semántica.
packages/obsidian-memory-rag/ Python Motor de búsqueda FTS5/BM25 + vectorial (pip install -e desde el código); cero dependencias por defecto.
cmd/obsidian-memoryd/ Go Daemon opcional: vigila el vault y sincroniza git.

Mapa técnico completo y diagramas de flujo: ARCHITECTURE.md. El porqué de cada decisión: docs/adr/.


Más · More

Licencia · License

MIT — ver LICENSE.

About

An operational prompt that lets an agent set up persistent, cross-device memory for itself using Obsidian MCP and a private GitHub vault on Windows.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors