Flema Engram Sidebar
Local-first OpenCode plugin/sidebar for Engram memory and SDD context, with an optional MCP stdio adapter
4
+3 in 30 days
793
515 in 7 days
47.6
Multi-signal model
7 days ago
2026-09-27
Install and configure
opencode.jsonWrites to this project's opencode.json — applies to this repository only.
opencode.json
{
"$schema": "https://opencode.ai/config.json",
"plugin": ["opencode-flema-engram-sidebar@0.1.7"]
}Writes to ~/.config/opencode/opencode.json — applies to every project.
~/.config/opencode/opencode.json
{
"$schema": "https://opencode.ai/config.json",
"plugin": ["opencode-flema-engram-sidebar@0.1.7"]
}If you want to modify the plugin locally, install it into the project and reference the local path.
shell
pnpm add -D opencode-flema-engram-sidebarOpenCode loads npm dependencies through its embedded runtime on startup and caches them locally — no manual global install needed.
Un sidebar local y de solo lectura que mantiene visible el contexto reciente de Engram mientras trabajás dentro de OpenCode.
La canción “Y aún yo te recuerdo” inspiró artísticamente la idea central: que la última memoria guardada siga presente en el contexto de desarrollo. Esta referencia es un homenaje a esa inspiración; no implica afiliación, patrocinio ni titularidad sobre la obra.
English summary: Flema Engram is a local-first, read-only OpenCode plugin/sidebar that surfaces Engram health, project context, recent memories, blockers, and SDD progress. An MCP stdio adapter is included only as an optional integration path.
Inicio rápido
Requisitos
| Componente | Requisito |
|---|---|
| Node.js | 22 o posterior |
| OpenCode | 1.18.25 o posterior |
| Engram | Servicio HTTP local activo en http://127.0.0.1:7437 (o accesible vía red en <host>:7437 cuando se usa opencode attach) |
| Proyecto | Alguna observación o sesión reciente que permita validar el nombre |
1. Registrá el sidebar en tui.json
Configuración mínima:
{
"$schema": "https://opencode.ai/tui.json",
"plugin": ["opencode-flema-engram-sidebar"]
}
Puedes encontrar la ruta completa de tu archivo
tui.jsonejecutandoopencode debug tui-path.
Una vez guardado el archivo, reinicia OpenCode para que el plugin se cargue.
Usando opencode attach
Si vas a conectarte a una instancia remota de OpenCode mediante opencode attach <url>, el plugin funcionará siempre que:
- El servicio Engram en la máquina remota sea accesible en el puerto 7437 (por defecto solo escucha en 127.0.0.1; se recomienda crear un puente TCP como se describe en los documentos internos o usar
engram-bridge.service). - El plugin descargará automáticamente la versión más reciente desde NPM al iniciar el attach.
- Verás en el sidebar la línea
🔌 Target: Local=<host>:7437 | Cloud=<URL>para confirmar a qué endpoints se está conectando.
2. Iniciá Engram y abrí OpenCode en tu proyecto
El sidebar hace una carga inicial, vuelve a consultar cada 30 segundos de forma predeterminada y permite refrescar manualmente con Alt+R.
Qué es — y qué no es
| Sí es | No es |
|---|---|
Un plugin para el slot sidebar_content de OpenCode |
Una TUI independiente |
| Una vista local y de solo lectura sobre Engram | Un reemplazo de Engram |
| Un resumen de contexto, actividad y avance SDD | Un editor o gestor de memorias |
| Un cliente del HTTP local de Engram | Un servicio cloud o de sincronización |
| Un paquete con un adaptador MCP stdio opcional | Un producto centrado en MCP |
El sidebar es el producto principal. El comando MCP existe para integraciones avanzadas y puede ignorarse por completo al usar el plugin de OpenCode.
Cómo funciona
- OpenCode carga el export raíz de
opencode-flema-engram-sidebar. - El plugin resuelve un candidato de proyecto y lo valida contra los proyectos derivados de observaciones y sesiones recientes de Engram.
- Consulta en paralelo salud, proyectos y observaciones del proyecto.
- Ordena la actividad por actualización más reciente, detecta artefactos SDD y reconoce bloqueos explícitos.
- Renderiza texto dentro del sidebar de la sesión visible y conserva datos útiles
como
STALEsi una actualización posterior queda incompleta.
Las llamadas usan exclusivamente GET contra el Engram local. El plugin no guarda,
edita ni elimina memorias.
Endpoints utilizados
| Propósito | Endpoint local |
|---|---|
| Salud | GET /health |
| Observaciones | GET /observations/recent |
| Sesiones para derivar proyectos | GET /sessions/recent |
El adaptador local usa un timeout de 5 segundos. Para mantener la vista acotada, el sidebar solicita hasta 20 observaciones del proyecto; si la respuesta filtrada está vacía o mezcla proyectos, usa una consulta sin filtro de hasta 100 registros y aplica una coincidencia exacta local.
Configuración
Opciones soportadas por el plugin
Usá la forma [plugin, options] solamente cuando necesites opciones:
{
"$schema": "https://opencode.ai/tui.json",
"plugin": [
[
"opencode-flema-engram-sidebar",
{
"enabled": true,
"project": "mi-proyecto",
"pollInterval": 30000
}
]
]
}
| Opción | Tipo | Comportamiento |
|---|---|---|
enabled |
boolean |
false evita que el plugin registre el sidebar. Por defecto está habilitado. |
project |
string |
Nombre exacto de proyecto Engram. Tiene la prioridad más alta. |
pollInterval |
number |
Intervalo automático en milisegundos; debe ser mayor que cero. Por defecto: 30000. |
No hay una opción TUI para cambiar la URL o el timeout del HTTP local. El plugin
incluido usa http://127.0.0.1:7437 y 5 segundos respectivamente.
Resolución del proyecto
La precedencia real es:
projectno vacío en eltui.jsonque declara el plugin;- variable de entorno
ENGRAM_PROJECTno vacía; - nombre normalizado del directorio de trabajo y, como segundo candidato automático, su ruta absoluta normalizada.
$env:ENGRAM_PROJECT = "mi-proyecto"
opencode .
Cada candidato debe coincidir con un proyecto conocido por Engram. Se acepta una coincidencia exacta o una única coincidencia sin distinguir mayúsculas. Un valor explícito o de entorno inválido no cae silenciosamente al nombre del directorio. Tampoco hay búsqueda difusa, recorrido de directorios padre, selector ni elección automática del primer proyecto.
Tema
El render del plugin usa el color de texto del tema activo que entrega OpenCode y no impone una paleta ni crea archivos de tema propios. Los estados también se distinguen por etiquetas e iconos, no solamente por color.
Qué muestra el sidebar
Health
| Estado | Significado |
|---|---|
CHECKING |
La carga inicial todavía no terminó. |
OK |
El HTTP local responde y las observaciones requeridas se obtuvieron. |
STALE |
Hay datos utilizables o previos, pero una etapa de la actualización quedó incompleta. |
ERROR |
Hubo respuesta parcial o un fallo de salud sin una carga completa. |
OFFLINE |
No pudo obtenerse información central de Engram. |
Los fallos muestran la etapa o endpoint relevante. Un error queda contenido en el sidebar para no derribar el host de OpenCode.
Proyecto y contexto detectado
Muestra el nombre validado del proyecto o unresolved. Cuando no puede resolverlo,
explica si falta configuración, el candidato no existe, es ambiguo o Engram estaba
offline durante la validación.
Observaciones indexadas
La línea Indexed observations refleja las observaciones del proyecto cargadas para
la vista actual, dentro del límite acotado del sidebar; no debe interpretarse como un
contador histórico total de toda la base. Si no hay registros, se muestra un estado
vacío explícito.
Avance SDD
Agrupa observaciones cuyo topic_key sigue sdd/<cambio>/<artefacto>. Reconoce las
fases init, explore, proposal, spec, design, tasks, apply, verify y
archive, incluidos los alias apply-progress, verify-report y archive-report.
Presenta el estado derivado y la secuencia de fases observadas. Si no hay cambios
activos o detectables, indica No active SDD changes.
Bloqueos
Lista títulos de observaciones reconocidas como bloqueos por tipo, título o frases
explícitas como status: blocked, blocker:, blocked by, depends on o
waiting for. No infiere bloqueos a partir de sentimiento o contexto ambiguo.
Actividad reciente
Muestra los títulos de las cinco observaciones más recientes del proyecto, ordenadas
por updated_at y luego por ID. Cuando no hay actividad, aparece un estado vacío.
Última memoria guardada
No existe un panel duplicado para “última memoria”: la observación actualizada más reciente ocupa el primer lugar de Recent Activity. La vista muestra su título, no el contenido completo. Así mantiene presente la referencia más nueva sin convertir el sidebar en un explorador de memorias.
Refresh, carga y errores
- La primera carga se agenda una sola vez para el sidebar de la sesión visible.
- El polling automático usa
pollIntervalo 30 segundos. - Alt+R vuelve a resolver el proyecto y repite todas las consultas.
- La tecla
rsin modificadores queda libre para escribir en el prompt. Refreshing…,RefreshedyRefresh incompletedescriben el resultado manual.- Los datos anteriores se conservan como
STALEcuando siguen siendo útiles. - Un proyecto sin observaciones, sin cambios SDD o sin bloqueos tiene mensajes vacíos propios; no se confunde con un error de conexión.
Ejemplos de uso
Detección automática desde el directorio
cd mi-proyecto
opencode .
Si Engram conoce mi-proyecto, el sidebar valida ese nombre y carga sus memorias.
Fijar un proyecto por workspace
{
"$schema": "https://opencode.ai/tui.json",
"plugin": [
["opencode-flema-engram-sidebar", { "project": "backend-api" }]
]
}
Esto es útil cuando el nombre del directorio no coincide con el proyecto guardado en
Engram. El valor debe coincidir; una configuración incorrecta queda como unresolved.
Reducir la frecuencia de actualización
{
"$schema": "https://opencode.ai/tui.json",
"plugin": [
["opencode-flema-engram-sidebar", { "pollInterval": 60000 }]
]
}
El sidebar actualizará cada 60 segundos y seguirá aceptando Alt+R.
Instalación desde el código fuente
git clone https://github.com/oniricosistemas/flema-engram.git
cd flema-engram
npm install
El archivo versionado tui.example.json es la referencia para desarrollo desde el
código fuente y apunta directamente a:
{
"$schema": "https://opencode.ai/tui.json",
"plugin": [["./src/sidebar/plugin.tsx", {}]]
}
Creá tu copia local con Copy-Item tui.example.json tui__.json en PowerShell o
cp tui.example.json tui__.json en shells compatibles. tui__.json está ignorado
por Git a propósito: es la copia local para adaptar sin versionar rutas u opciones
específicas de tu máquina. Si tu entorno requiere el nombre tui.json, copiá allí el
contenido de tui__.json o fusioná su bloque plugin en tu configuración existente.
La ruta se resuelve desde el archivo que declara el plugin. En una configuración global de Windows, reemplazá la ruta relativa de tu copia local por una URL absoluta:
{
"$schema": "https://opencode.ai/tui.json",
"plugin": [
["file:///D:/general/mcp-flema-engram/src/sidebar/plugin.tsx", {}]
]
}
Preservá el resto de tus plugins y opciones al fusionar la configuración.
Solución de problemas
Engram aparece offline
- Confirmá que Engram escuche en
127.0.0.1:7437. - Probá
http://127.0.0.1:7437/healthdesde la misma máquina. - Revisá firewalls o proxies locales; el plugin no intenta conectarse a un servicio cloud como alternativa.
- Corregí la causa y presioná Alt+R.
El proyecto no se detecta
- Verificá el nombre real guardado en Engram.
- Definí
projectentui.jsonsi el workspace tiene otro nombre. - Usá
ENGRAM_PROJECTsolamente cuando deba aplicar al proceso completo. - Recordá la precedencia:
projectexplícito gana sobreENGRAM_PROJECT. - Un proyecto sin observaciones ni sesiones recientes puede no aparecer en la lista derivada que se usa para validarlo.
Los datos parecen viejos
- Mirá si Health dice
STALEy leé el detalle de etapa/endpoint. - Esperá el próximo polling o usá Alt+R.
- Confirmá que la memoria pertenece exactamente al proyecto resuelto.
- El feed solo muestra cinco títulos y la consulta del sidebar está acotada a 20 observaciones.
El plugin no carga
- Cerrá y reiniciá OpenCode después de cambiar
tui.json. - Validá el JSON y la ruta del plugin.
- Confirmá Node.js 22+ y OpenCode 1.18.25+.
- Para npm, usá el nombre exacto
opencode-flema-engram-sidebar. - Para fuente local, ejecutá
npm instally comprobá que la ruta termine ensrc/sidebar/plugin.tsx. - Revisá la salida de arranque de OpenCode. El plugin no crea archivos de log propios.
OpenCode no encuentra el export del paquete
- Confirmá que la versión instalada tiene un export raíz por defecto con
idytui. - Ejecutá
npm view opencode-flema-engram-sidebar exportspara inspeccionar la metadata publicada. - Si trabajás sobre un tarball local, verificá que incluya
dist/index.js,dist/sidebar/plugin.jsy sus declaraciones. - Usá
opencode-flema-engram-sidebaren la configuración. El subpath/tuiqueda disponible para imports directos, pero OpenCode 1.18.25 puede no cachear ese spec de npm de forma confiable.
Diagnóstico para contribuidores
npm run typecheck
npm test
npm run verify:package
typecheck valida TypeScript sin emitir archivos; test ejecuta Vitest una vez; y
verify:package inspecciona un npm pack --dry-run contra el contenido compilado
existente. No hay una opción de log JSONL ni un archivo de diagnóstico del sidebar.
Desarrollo y contribución
npm ci
npm run typecheck
npm test
npm run build
npm run verify:package
| Comando | Qué comprueba |
|---|---|
npm ci |
Instala exactamente el árbol de package-lock.json; es el usado por CI. |
npm install |
Instala dependencias y permite actualizar el lockfile en desarrollo. |
npm run typecheck |
Ejecuta tsc --noEmit con configuración estricta. |
npm test |
Ejecuta la suite unitaria y de integración con Vitest. |
npm run test:watch |
Mantiene Vitest activo durante el desarrollo. |
npm run test:coverage |
Genera cobertura mediante V8. |
npm run build |
Compila src a ESM, declaraciones y sourcemaps en dist. |
npm run verify:package |
Valida metadata y contenido del tarball sin publicarlo. Requiere un dist actualizado. |
npm run mcp |
Inicia desde fuente el adaptador MCP stdio opcional mediante tsx. |
La CI usa Node 22 y ejecuta, en este orden: typecheck, tests, build y verificación del paquete. No publica artefactos ni necesita secretos. Antes de proponer un cambio:
- Mantené el sidebar como producto principal y el MCP como integración opcional.
- No introduzcas escrituras sobre Engram en el flujo de solo lectura.
- Agregá o actualizá pruebas para cambios de comportamiento.
- Ejecutá los cuatro checks de CI.
- No incluyas
src, tests, OpenSpec, configs locales ni logs en el tarball.
Empaquetado y publicación
La lista files permite publicar dist, README.md y LICENSE; npm agrega además
la metadata obligatoria. El verificador exige, como mínimo:
- API raíz:
dist/index.jsydist/index.d.ts; - plugin:
dist/sidebar/plugin.jsydist/sidebar/plugin.d.ts; - CLI opcional:
dist/stdio.js; - README, licencia y
package.json.
prepublishOnly ejecuta automáticamente:
npm run typecheck && npm test && npm run build && npm run verify:package
Para publicar necesitás permisos sobre
opencode-flema-engram-sidebar,
una sesión npm válida y un package.json con versión todavía no publicada. Este
repositorio no configura publicación automática, tokens ni secretos.
Integración MCP opcional
Sección avanzada: no es necesaria para usar el sidebar.
La instalación global expone el comando stdio:
mcp-flema-engram
Desde el repositorio puede iniciarse sin compilar con:
npm run mcp
Ejemplo de configuración local de OpenCode, equivalente a opencode.example.json:
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"engram": {
"type": "local",
"command": ["npm", "run", "mcp"],
"enabled": true
}
}
}
El servidor ofrece herramientas y recursos MCP de lectura para salud, proyectos, observaciones, sesiones y cambios SDD. Sigue usando el mismo HTTP local de Engram; no agrega persistencia ni sincronización cloud.
Seguridad, privacidad y enfoque local-first
- Los datos de Engram permanecen en la máquina y el runtime consulta loopback.
- El sidebar no requiere credenciales, telemetría ni servicios cloud.
- No ejecuta operaciones de escritura sobre memorias.
- No crea logs propios con contenido de observaciones.
- El contenido de memorias puede ser sensible: protegé el acceso al proceso y puerto local de Engram como protegerías cualquier herramienta de desarrollo.
- Las conexiones externas solo son necesarias para tareas ajenas al runtime local, como instalar desde npm o abrir enlaces de documentación.
El repositorio contiene una clase experimental de adaptador cloud con operaciones no implementadas. No forma parte del flujo del plugin ni constituye soporte cloud.
Roadmap y alcance diferido
Están explícitamente fuera del MVP actual:
- dashboard visual y acciones/atajos para abrirlo;
- conexión remota mediante
opencode attach; - selector manual de proyecto, navegación
j/ky más atajos globales; - configuración de URL/timeout desde
tui.json; - sincronización cloud y edición de memorias.
Licencia y enlaces
Distribuido bajo la licencia MIT.
Similar plugins
Memory
@navopw/opencode-memory
Persistent semantic memory for OpenCode
Mempalace Persistence
opencode-mempalace-persistence
OpenCode plugin — auto-sync conversations to MemPalace memory in real-time. No forced wings, KG extraction via MCP tools.
Switchboard
@egoistmachines/opencode-switchboard
Local-first AI Passport memory for OpenCode.