https://github.com/vahlame/obsidian-memory-kit
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.
https://github.com/vahlame/obsidian-memory-kit
agent-memory agents-md ai-agents github-sync mcp model-context-protocol obsidian persistent-memory powershell windows
Last synced: about 4 hours ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/vahlame/obsidian-memory-kit
- Owner: Vahlame
- License: mit
- Created: 2026-05-13T04:49:25.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-07-01T19:53:13.000Z (1 day ago)
- Last Synced: 2026-07-02T08:19:39.403Z (1 day ago)
- Topics: agent-memory, agents-md, ai-agents, github-sync, mcp, model-context-protocol, obsidian, persistent-memory, powershell, windows
- Language: JavaScript
- Homepage:
- Size: 6.88 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
🧠 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.
📖 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**](docs/es/como-funciona.md) · [**How it works**](docs/en/how-it-works.md).
---
## 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:
```bash
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 "" -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 `):
>
> ```bash
> 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`),
> instala un hook `SessionStart` del vault (ADR-0029), dos hooks de aplicación determinista —
> bloqueo de escritura a la memoria nativa + recordatorio de cierre — para que funcione con
> cualquier modelo (ADR-0030), y un hook de "effort gate" que pausa de verdad antes de
> ediciones sustanciales hasta que el usuario confirma (ADR-0031). ¿Solo lo básico? usa
> `--ide codex,claude`.
> Guía completa: [🇪🇸 instalar en PC nueva](docs/es/instalar-pc-nueva.md) ·
> [🇬🇧 fresh-PC install](docs/en/install-fresh-pc.md).
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 →](docs/es/instalacion.md)**
o deja que [**un agente lo instale**](docs/es/instalar-con-agente.md)
🇬🇧 **[Install guide →](docs/en/install.md)**
or let [**an agent install it**](docs/en/install-with-agent.md)
---
## Qué incluye · What's inside
| Pieza · Piece | Lenguaje | Rol |
| ---------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| [`packages/create-obsidian-memory/`](packages/create-obsidian-memory/) | Node | Instalador `npx` **(npm)**: fusiona el MCP y crea el vault. |
| [`packages/obsidian-memory-mcp/`](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/`](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/`](cmd/obsidian-memoryd/) | Go | Daemon opcional: vigila el vault y sincroniza git. |
Mapa técnico completo y diagramas de flujo: [`ARCHITECTURE.md`](ARCHITECTURE.md). El _porqué_ de
cada decisión: [`docs/adr/`](docs/adr/).
---
## Más · More
- **Seguridad / confianza:** [`SECURITY.md`](SECURITY.md) — el vault es **datos**, no instrucciones.
- **PC nuevo · Fresh PC (Claude Code):** [🇪🇸 instalar en PC nueva](docs/es/instalar-pc-nueva.md) · [🇬🇧 fresh-PC install](docs/en/install-fresh-pc.md).
- **Comparación con alternativas:** [FAQ 🇪🇸](docs/es/faq.md) · [FAQ 🇬🇧](docs/en/faq.md).
- **Contribuir:** [`CONTRIBUTING.md`](CONTRIBUTING.md) · **Para agentes que tocan este repo:** [`AGENTS.md`](AGENTS.md).
- **Privacidad / telemetría:** [`docs/observability.md`](docs/observability.md).
## Licencia · License
MIT — ver [`LICENSE`](LICENSE).