XMemo
Memoria propiedad del usuario para agentes de IA a través de MCP remoto. Guarda, busca, recuerda, actualiza y gestiona memorias con alcance en Copilot, Claude, ChatGPT, IDEs y CLIs.
Documentación
CLI de XMemo
Una capa de memoria privada para cada agente de IA.
Instala, autentica, diagnostica y conecta XMemo entre editores, CLIs y agentes autónomos desde una única línea de comandos lista para producción.
Inicio rápido · Integraciones · Modos de conexión · Plugins · Comandos · Versionado · Seguridad
@xmemo/client es el plano de control oficial para conectar herramientas de IA a
XMemo. Hace que la configuración sea repetible, mantiene las credenciales fuera de los
archivos del proyecto y brinda a cada cliente compatible una ruta consistente hacia una memoria
duradera y propiedad del usuario.
El paquete es deliberadamente pequeño: el runtime de la CLI, la configuración segura del cliente, los perfiles de comportamiento, las habilidades de XMemo y los metadatos del marketplace. El código del servidor, las bases de datos, los archivos de despliegue, los registros y las operaciones internas permanecen fuera de la distribución de npm.
Arquitectura
| Paquete | @xmemo/client |
| Comando principal | xmemo (alias: client) |
| Comando MCP local | xmemo-mcp |
| MCP alojado | https://xmemo.dev/mcp |
| Runtime | Node.js 20 o posterior |
| Licencia | MIT |
Por qué XMemo CLI
- Un solo plano de control — inicio de sesión, diagnósticos, configuración, perfiles, actualizaciones y comprobaciones rápidas comparten una interfaz predecible.
- Privado por diseño — la configuración generada del proyecto referencia una credencial; nunca incrusta el valor de la credencial.
- Nativo donde importa — OpenClaw y Hermes usan integraciones de memoria dedicadas en lugar de duplicar la misma capacidad a través de MCP.
- Portátil en cualquier otro lugar — MCP HTTP Streamable alojado y stdio local cubren editores modernos, terminales y runtimes de agentes.
- Automatización segura — las rutas de instalación y eliminación compatibles ofrecen vista previa, ejecución en seco o confirmación explícita antes de realizar cambios.
- Superficie de cadena de suministro pequeña — el paquete npm está gobernado por una lista blanca de archivos explícita y procedencia de publicación.
Inicio rápido
Incorporación guiada (xmemo init)
Para una experiencia interactiva de primera ejecución que abarca autenticación de cuenta, clientes detectados, instrucciones de comportamiento del agente, configuración del servidor MCP, habilidades y plugins, ejecuta:
npm install -g @xmemo/client
xmemo init
Banderas y opciones:
xmemo init --dry-run: Ver el plan de incorporación completo sin realizar llamadas de red ni escrituras en disco.xmemo init --yes: Aceptar y aplicar automáticamente todos los pasos de incorporación sin indicaciones interactivas.xmemo init --json: Emitir JSON estructurado para el plan o el sobre de resultados.xmemo init --client <id>...: Restringir la incorporación a clientes específicos (p. ej.,cursor,codex,claude-code).xmemo start: Alias dexmemo initcon pasos de recorrido de inicio rápido.
La instalación global expone xmemo como comando principal y también proporciona client y memory-os como alias.
Configuración manual paso a paso
xmemo account login
xmemo doctor
xmemo setup codex
xmemo status
Reemplaza codex con tu cliente. Previsualiza una configuración antes de escribirla:
xmemo setup cursor --dry-run
Ejecutar con npx
También puedes ejecutar cualquier comando de la CLI directamente sin una instalación global mediante npx @xmemo/client <command>:
# Check version or health
npx @xmemo/client --version
npx @xmemo/client doctor
# Guided onboarding without global install
npx @xmemo/client init
# Install skill or run MCP stdio server
npx @xmemo/client skill install
npx @xmemo/client mcp serve
[!TIP] Comienza con
xmemo init(oxmemo account login,xmemo doctoryxmemo setup <client>). Edita manualmente la configuración de MCP solo cuando un cliente no tenga una ruta de configuración verificada.
Cómo encajan los comandos
La arquitectura de la CLI de XMemo se basa en cuatro principios de diseño fundamentales:
1. Gramática de recursos unificada (xmemo <resource> <action>)
Cada componente de integración es un recurso de primera clase con acciones de ciclo de vida predecibles:
| Recurso | Alcance | Acciones | Ejemplos |
|---|---|---|---|
mcp | Configuración de conexión del servidor MCP | install, remove, status | xmemo mcp install codex, xmemo mcp status |
plugin | Paquetes de extensión nativos del host | install, remove, status, list, info | xmemo plugin install gemini-cli, xmemo plugin list |
skill | Scripts y documentación de habilidades del agente | install, remove, status, update | xmemo skill install --client openclaw |
profile | Instrucciones de dirección de comportamiento en Markdown | install, remove, status, show | xmemo profile install cursor |
- Comandos compuestos:
xmemo setup [<client>...],xmemo uninstall [<client>...]yxmemo status [<client>]orquestan estos recursos en un solo paso según el perfil declarativo del cliente. - Alias compatibles con versiones anteriores: Comandos conocidos como
xmemo mcp add(alias demcp install),xmemo profile uninstall(alias deprofile remove) yxmemo skill uninstall(alias deskill remove) siguen siendo totalmente funcionales e imprimen una pista útil de una línea en terminales interactivos.
2. Resolutor de destino unificado
Cuando no se pasa ningún cliente explícitamente, la CLI usa un modelo de resolución determinista de tres niveles por precedencia:
- Bandera o argumento explícito:
--client <id>, argumento posicional del cliente o--all. - Entorno del agente llamante: Identifica automáticamente el runtime del agente llamante cuando se ejecuta dentro de una sesión de agente (p. ej.,
CLAUDECODE/CLAUDE_CODE_ENTRYPOINTse asigna aclaude-code, yCODEX_THREAD_ID/CODEX_SESSION_IDse asigna acodex). - Clientes instalados detectados: Inspecciona rutas de configuración locales y marcadores. Si se encuentra exactamente un cliente coincidente, se selecciona automáticamente; si se encuentran varios clientes en modo interactivo, se presenta un selector interactivo. La CLI nunca escribe silenciosamente configuración en rutas arbitrarias no verificadas.
3. Planificar, confirmar una vez, aplicar (PlanRunner)
Los comandos de mutación siguen un patrón de ejecución estricto y atómico:
- Construir plan: Ensambla una secuencia ordenada de acciones entre recursos (p. ej., instalación de plugin seguida de configuración de habilidad).
- Previsualizar: Imprime el plan completo (incluyendo rutas modificadas, comandos y diferencias unificadas) en la terminal.
- Confirmar una vez: Solicita
[y/N]exactamente una vez para toda la secuencia. Volver a ejecutar con--yeso-yomite la solicitud;--dry-runmuestra la vista previa sin mutación. - Aplicar secuencialmente: Los pasos se ejecutan en orden de dependencia, deteniéndose inmediatamente ante el primer fallo. Volver a ejecutar en un cliente ya configurado detecta que todos los componentes están actualizados e informa
Nothing to do.
4. Registro declarativo de clientes
Todas las configuraciones de clientes, recetas y capacidades se declaran centralmente en src/clients/registry.js. Las implementaciones de comandos son orquestadores puramente genéricos con cero cadenas de ID de cliente codificadas. Las plataformas también se pueden agregar dinámicamente en tiempo de ejecución mediante registerClient().
Integraciones compatibles
| Cliente | Comando recomendado | Conexión |
|---|---|---|
| Codex | xmemo setup codex | MCP alojado + perfil de comportamiento |
| Cursor | xmemo setup cursor | MCP alojado + Bearer Token + perfil de comportamiento |
| Copilot CLI | xmemo setup copilot | Proxy autenticado local |
| Gemini CLI | xmemo setup gemini | MCP alojado + OAuth |
| Antigravity | xmemo setup antigravity | MCP alojado + OAuth |
| OpenClaw | xmemo setup openclaw | Plugin de memoria nativo + Skill |
| Hermes | xmemo setup hermes | Proveedor de memoria nativo |
| Kiro | xmemo setup kiro | HTTP OAuth nativo; --auth key para API Key |
| Grok | xmemo setup grok | MCP alojado |
| Otros clientes MCP | xmemo mcp config --client generic | Plantilla generada |
El registro de clientes también cubre Devin Desktop (anteriormente Windsurf), Cline, Continue, Claude Desktop,
Claude Code, Kimi Code, Zed, JetBrains, OpenCode, Qwen, Trae y hosts
MCP compatibles. Ejecuta xmemo mcp list para obtener el catálogo actual legible por máquina.
Para usuarios de VS Code que buscan la extensión de editor dedicada, consulta el repositorio yonro/xmemo-vscode. Para usuarios de Cursor que buscan el plugin dedicado, consulta el repositorio yonro/xmemo-cursor-plugin. Para usuarios de Claude que buscan el plugin dedicado, consulta el repositorio yonro/xmemo-claude-plugin.
Modos de conexión
MCP alojado
La ruta universal recomendada es el endpoint XMemo Streamable HTTP:
https://xmemo.dev/mcp
Los clientes con capacidad OAuth completan la autenticación en el navegador. Otros clientes
hacen referencia a XMEMO_KEY sin copiar su valor en los archivos del repositorio.
Forma genérica de configuración:
{
"mcpServers": {
"XMemo": {
"type": "streamable-http",
"url": "https://xmemo.dev/mcp",
"headers": {
"Authorization": "Bearer ${XMEMO_KEY}"
}
}
}
}
Las claves de configuración del cliente difieren; prefiere xmemo setup <client> en lugar de copiar
este ejemplo genérico directamente.
MCP stdio local
xmemo-mcp es el punto de entrada stdio dedicado para marketplaces y clientes
que lanzan un proceso local. El descubrimiento seguro expone 20 herramientas, tres prompts
y dos recursos de documentación sin token. La ejecución de herramientas aún requiere
autenticación.
Después de una instalación global:
xmemo-mcp
Configuración MCP sin instalación:
{
"mcpServers": {
"XMemo": {
"command": "npx",
"args": [
"-y",
"--package",
"@xmemo/client@latest",
"xmemo-mcp"
]
}
}
}
xmemo mcp serve es equivalente cuando la CLI ya está instalada.
Integraciones nativas
OpenClaw y Hermes tienen proveedores de memoria dedicados. Su configuración predeterminada evita instalar una segunda superficie de herramientas XMemo duplicada:
- OpenClaw: instala el plugin fijado
clawhub:@xmemo/openclaw-memory@1.0.18sin--forcede forma predeterminada. Volver a ejecutar la configuración detecta correctamente las instalaciones existentes; usa--forcepara reinstalar o sobrescribir. - Hermes: instala el paquete de proveedor fijado
hermes-xmemo==1.1.3mediantepip installsin-U. - Cada comando de instalación imprime el comando exacto antes de ejecutarlo. Usa
--dry-runpara previsualizar acciones sin instalar.
# Native OpenClaw plugin (clawhub:@xmemo/openclaw-memory@1.0.18) + XMemo Skill
xmemo setup openclaw
# Native Hermes memory provider (hermes-xmemo==1.1.3)
xmemo setup hermes
Agrega MCP alojado solo cuando se desee una alternativa explícita:
xmemo setup openclaw --with-mcp
xmemo setup hermes --with-mcp
Usa --mcp-only para omitir la integración nativa e instalar solo la alternativa
de MCP alojado.
Instalación de la habilidad XMemo
La CLI instala la Habilidad XMemo verificada localmente en las carpetas de habilidades del agente o en un directorio de destino:
- Instala en los directorios de habilidades del cliente:
- Claude Code:
~/.claude/skills/xmemo-memory(global) o.claude/skills/xmemo-memory(proyecto con--project) - Codex:
~/.codex/skills/xmemo-memory - OpenClaw:
~/.openclaw/skills/xmemo-memory - Los otros 21 clientes permanecen
nullhasta que se documenten oficialmente.
- Claude Code:
- Usa de forma predeterminada la versión fijada
@xmemo/skill@1.1.35de npm y verifica la integridad del tarball (sha512 SRI) antes de la extracción. - Anula la versión con
--version <semver>o acepta explícitamente la última versión mediante--version latest. - Para instalaciones aisladas o sin conexión, instala desde un directorio local o tarball empaquetado con
--from <dir|tgz>(opcional--integrity <sha512>). - Gestiona las habilidades del cliente con
skill status,skill updateyskill remove. - Previsualiza acciones sin escribir archivos usando
--dry-run. - Seguridad y consentimiento:
- La instalación interactiva solicita
[y/N]antes de escribir (Enter, EOF o entrada vacía cancela) a menos que se especifique--yes. - Las instalaciones existentes rechazan la sobrescritura sin
--force; cuando se usa--force, se crea una copia de seguridad en~/.xmemo/backups/skills/<client>/(fuera del directorio de habilidades del agente). skill removesolo elimina directorios de habilidades XMemo verificados, rechaza carpetas ajenas e informa la ubicación de la copia de seguridad conservada.
- La instalación interactiva solicita
# Install to agent skill folder (Claude Code global, Codex, or OpenClaw)
xmemo skill install --client claude-code
xmemo skill install --client codex
xmemo skill install --client openclaw
# Install OpenClaw skill globally (shared ~/.openclaw/skills)
xmemo skill install --client openclaw --global
# Install to project-level skill folder (Claude Code project: .claude/skills/xmemo-memory)
xmemo skill install --client claude-code --project
# Install for all detected supported clients
xmemo skill install --all
# Default install into current directory (./xmemo-skill)
xmemo skill install
xmemo skill install --dir ./custom-skill-dir
# Non-interactive install (skips [y/N] prompt)
xmemo skill install --client codex --yes
# Replace existing installation (creates backup in ~/.xmemo/backups/skills/<client>/)
xmemo skill install --client codex --force --yes
# Update alias (equivalent to skill install --force)
xmemo skill update --client codex --yes
# Inspect installation status across clients
xmemo skill status
xmemo skill status --client codex
xmemo skill status --all --json
# Remove installed skill from an agent folder (refuses non-XMemo folders)
xmemo skill remove --client codex --yes
xmemo skill remove --client claude-code --project --yes
# Dry run preview
xmemo skill install --client codex --dry-run
Instaladores independientes curl y PowerShell
Para entornos sin Node.js o @xmemo/client, XMemo proporciona instaladores HTTPS independientes en https://xmemo.dev/skill/install (POSIX sh) y https://xmemo.dev/skill/install.ps1 (PowerShell).
El instalador es consciente del agente y resuelve automáticamente el directorio de destino correcto para tu agente activo:
# Claude Code: installs to ~/.claude/skills/xmemo-memory
curl -fsSL https://xmemo.dev/skill/install | XMEMO_SKILL_AGENT=claude-code sh
# Codex: installs to ${CODEX_HOME:-$HOME/.codex}/skills/xmemo-memory
curl -fsSL https://xmemo.dev/skill/install | XMEMO_SKILL_AGENT=codex sh
# OpenClaw: install via OpenClaw CLI
openclaw skills install @xmemo/xmemo --version 1.1.35
# Windows (PowerShell):
# $env:XMEMO_SKILL_AGENT="claude-code"; irm https://xmemo.dev/skill/install.ps1 | iex
# $env:XMEMO_SKILL_AGENT="codex"; irm https://xmemo.dev/skill/install.ps1 | iex
Precedencia de resolución de destino (gana la primera coincidencia):
XMEMO_SKILL_DIR: Instala en el directorio especificado.XMEMO_SKILL_AGENT=claude-code|codex: Instala en el directorio de habilidades del agente explícito (openclawredirige aopenclaw skills install xmemo).- Detección automática: Detecta automáticamente Claude Code (
CLAUDECODE=1) o Codex (CODEX_THREAD_ID,CODEX_SESSION_IDoCODEX_HOME). - Descubrimiento del directorio de inicio: Si solo existe
~/.claudeo solo~/.codexen HOME, selecciona ese agente. - Respaldo: Instala en
./xmemo-skillcon una advertencia en stderr explicando que los agentes de IA no cargarán automáticamente la habilidad desde este directorio.
Seguridad y reemplazo:
- Se niega a sobrescribir instalaciones existentes a menos que se proporcione
XMEMO_SKILL_FORCE=1. - Al reemplazar, mueve la instalación anterior a
~/.xmemo/backups/skills/<agent>/<name>-<timestamp>(de forma segura fuera de las rutas de búsqueda de habilidades del agente). - Después de la instalación, imprime la ruta de instalación absoluta, el comando de verificación del doctor (
node <path>/scripts/xmemo-skill.mjs doctor --anonymous) y un aviso para recargar tu agente.
Plugins de agente
La CLI proporciona un índice estático y curado de plugins de agente verificados enviados directamente en @xmemo/client. Cada entrada contiene una versión fijada, etiqueta de lanzamiento y SHA de commit de Git exacto resuelto en el momento del lanzamiento.
ℹ️ Regla de separación estricta:
xmemo plugininstala solo plugins de agente (p. ej.,@xmemo/openclaw-memory). Las habilidades se instalan exclusivamente mediantexmemo skill install(p. ej.,@xmemo/xmemo).
| ID de plugin | Plataforma / Agente | Tipo | Estado | Integración |
|---|---|---|---|---|
openclaw | OpenClaw | native-cli | Estable | openclaw plugins install clawhub:@xmemo/openclaw-memory@1.0.18 (solicita automáticamente update si ya está instalado) |
hermes | Hermes Agent | native-cli | Estable | hermes plugins install xmemo (respaldo: python -m pip install hermes-xmemo==1.1.3) |
claude-code | Claude Code | git-dir | Vista previa | Clon de Git fijado verificado contra el commit 5d0d280 (por defecto ~/.xmemo/plugins/claude-code) |
cursor | Cursor | marketplace | Vista previa | Plugin de Cursor Marketplace |
gemini-cli | Gemini CLI | native-cli | Vista previa | gemini extensions install https://github.com/yonro/xmemo-gemini-cli --ref 39e25b185b5157490d1683e4ca8c5c5fb1312a88 |
kiro | Kiro | manual | Vista previa | Reglas de dirección e integración de Power |
vscode | VS Code | manual | Vista previa | Pasos manuales de la extensión de VS Code (pendiente de publicación en el marketplace) |
deepseek-dsh | DeepSeek DSH | native-cli | Vista previa | dsh plugin --profile <name> add dsh-xmemo (requiere --profile) |
chatgpt-codex | ChatGPT / Codex | marketplace | Vista previa | Extensión de ChatGPT y Codex |
cindy | Cindy | manual | Vista previa | Integración de memoria nativa del agente |
codex | Codex | mcp | Vista previa | Configuración MCP dedicada (xmemo setup codex) |
Comandos:
# List available plugins (excluding legacy entries)
xmemo plugin list
# Include legacy plugins
xmemo plugin list --all
# View plugin details and verification metadata
xmemo plugin info <id>
# Preview install plan without executing
xmemo plugin install <id> --dry-run
# Install with explicit confirmation (prompts [y/N] by default)
xmemo plugin install <id>
# Non-interactive install
xmemo plugin install <id> --yes
# Specify profile for deepseek-dsh
xmemo plugin install deepseek-dsh --profile default --yes
# Specify custom target directory for git-dir plugins
xmemo plugin install claude-code --yes --dir ~/.custom-plugins/claude-code
# Open plugin documentation or marketplace in browser
xmemo plugin install <id> --open
# Check installation status
xmemo plugin status [<id>]
Seguridad y consentimiento:
- Solo se aceptan IDs de plugin verificados del índice estático; las URL arbitrarias y los IDs desconocidos se rechazan con el código de salida 2.
- La instalación interactiva siempre muestra el plan de ejecución y requiere consentimiento explícito (
[y/N], con valor predeterminado Cancelar en entrada vacía o EOF). --dry-rungarantiza cero escrituras en disco y cero procesos generados.- Los plugins de Marketplace y manuales muestran instrucciones paso a paso exactas del repositorio del plugin durante
plugin install <id>(pasa--openpara abrir la documentación en el navegador). - Los plugins de directorio Git (
claude-code) se clonan en una ubicación estable por usuario (~/.xmemo/plugins/<id>), admiten la anulación de--dir <path>, verifican el commitHEADdesplegado byte por byte y generan el comando de carga exacto (claude --plugin-dir <dir>). En caso de discrepancia de commit, el directorio se elimina inmediatamente. - Los procesos secundarios del plugin se ejecutan en un entorno aislado con tokens de autenticación (
XMEMO_KEY,MEMORY_OS_MCP_TOKEN,XMEMO_TOKEN) eliminados de argv y env.
Cuenta y autenticación
Comandos de cuenta
Administra la autenticación local, las credenciales almacenadas y los tokens mediante la familia de comandos account:
# Browser device login
xmemo account login
# Check active authentication state
xmemo account status
# Optional remote verification
xmemo account status --verify
# Check or store token credentials
xmemo account token status
printf '%s\n' 'your-token' | xmemo account token add --from-stdin --allow-plaintext
# Logout: remove locally stored XMemo credentials owned by the CLI
xmemo account logout
# Non-interactive logout
xmemo account logout --yes
Cierre de sesión seguro de cuenta (xmemo account logout)
- Eliminación de destino: Elimina solo el archivo de credenciales con ámbito de usuario propiedad de la CLI (
~/.config/xmemo/credentials.jsono raíz de configuración del SO). - Confirmación explícita: Muestra la ruta de credenciales de destino y solicita
Proceed with logout? [y/N](con valor predeterminado No) a menos que se especifique--yes. - Aislamiento de cliente y agente: Conserva todos los archivos de configuración MCP del cliente (Cursor, Claude, VS Code, etc.) y las sesiones OAuth administradas por el agente.
- Privacidad: Nunca muestra ni filtra valores de token en stdout, stderr o sobres JSON.
- Scripting: Requiere
--yescuando se especifica--jsonpara evitar el cierre de sesión sin supervisión accidental.
Alias de autenticación heredados
Los comandos heredados siguen siendo totalmente compatibles como alias retrocompatibles:
xmemo login(alias dexmemo account login)xmemo auth status(alias dexmemo account status)xmemo auth-status(alias dexmemo account status)xmemo token <status|add|set>(alias dexmemo account token <status|add|set>)
En el modo humano interactivo, los alias heredados emiten una sugerencia de desaprobación de una línea a stderr. Cuando se ejecuta con --json o --help, la sugerencia de desaprobación se suprime.
Importación de token existente
Envía un token existente a través de stdin para que no aparezca en el historial de comandos:
printf '%s\n' 'your-token' | xmemo account token add --from-stdin --allow-plaintext
xmemo account token status --verify
PowerShell:
$xmemoToken = Read-Host "XMemo token"
$xmemoToken | xmemo account token add --from-stdin --allow-plaintext
Remove-Variable xmemoToken
Para CI y estaciones de trabajo administradas, expón XMEMO_KEY a través del administrador de secretos de la plataforma. No lo confirmes en .env, configuración de MCP, registros, informes de problemas o transcripciones de chat.
Salida universal de --json
Cada comando y subcomando admite --json para scripting predecible:
- En caso de éxito: Genera JSON válido en
stdoutcon código de salida0. - En caso de error: Genera un sobre de error JSON estructurado
{ schemaVersion, ok: false, command, data: null, error: { code, message, ... } }enstdoutcon un código de salida distinto de cero (p. ej., código de salida2para errores de uso/entrada,1para errores internos/red).
Referencia de comandos
1. Comenzar
xmemo init [--client <id>...] [--yes] [--dry-run] [--json]
# Backward-compatible alias
xmemo start [--json]
2. Conectar agentes
# High-level client configuration
xmemo setup <client> [--url <url>] [--no-profile] [--json] [--force]
xmemo setup <client> --dry-run
xmemo setup --all [--write] [--profile] [--force]
# Direct MCP server configuration
xmemo mcp serve
xmemo mcp list
xmemo mcp config --client <client-id> [--base-url <url>] [--json]
xmemo mcp add <client-id> [--write] [--config <path>]
xmemo mcp proxy [--port 8765] [--base-url <url>]
# Workspace behavior profiles
xmemo profile install <client-id> [--target <path>] [--dry-run]
xmemo profile show <client-id> [--target <path>] [--json]
xmemo profile status <client-id> [--target <path>] [--json]
xmemo profile uninstall <client-id> [--target <path>] [--yes]
3. Habilidad
# Install verified pinned skill into agent skill folders
xmemo skill install [--client <id>|--all] [--project] [--dir <path>] [--dry-run] [--yes] [--force] [--json]
# Inspect installation status across clients
xmemo skill status [--client <id>|--all] [--json]
# Remove installed skill from an agent folder (refuses non-XMemo folders)
xmemo skill remove --client <id> [--project] [--yes] [--json]
# Update skill installation (creates backup in ~/.xmemo/backups/skills/<client>/)
xmemo skill update [--client <id>|--all] [--yes] [--json]
4. Plugins
xmemo plugin list [--all] [--json]
xmemo plugin info <id> [--json]
xmemo plugin install <id> [--dry-run] [--yes] [--open] [--dir <path>] [--json]
xmemo plugin status [<id>] [--all] [--json]
5. Memoria
xmemo memory add --content "Remember this" --path notes/example --json
xmemo memory search "example" --json
xmemo memory read <id> --json
xmemo memory list [--path-prefix <prefix>] [--project <name>] [--query <text>] [--type <type>] [--all] [--limit <n>] [--offset <n>] --json
xmemo memory delete <id> [--reason <text>] [--yes] --json
xmemo memory restore <id> [--yes] --json
xmemo memory import --file memories.jsonl [--dry-run] [--idempotency-key <key>] [--yes] --json
xmemo memory ledger-delete --id <transaction-uuid> --yes --json
xmemo context recall "resume this task" --include-knowledge --json
xmemo state save --current-task "ship the client" --next-action "run tests" --json
xmemo state restore --json
xmemo restart snapshot --json
xmemo restart restore --snapshot-id <snapshot-id> --json
xmemo knowledge add --base <base-id> --file ./guide.pdf --title "Guide" --json
xmemo knowledge search "setup" --base <base-id> --json
xmemo knowledge read <item-id> --json > knowledge-view.json
xmemo knowledge update <item-id> --text "Updated" --from knowledge-view.json --publish --yes --json
xmemo dream preview --wait --json
xmemo dream show <run-id> --json > dream-view.json
xmemo dream apply <run-id> --item <candidate-id> --from dream-view.json --yes --json
xmemo cloud-skill list --json
xmemo cloud-skill add --file ./SKILL.md --json
xmemo cloud-skill show <skill-id> --json > skill-view.json
xmemo cloud-skill update <skill-id> --from skill-view.json --file ./SKILL.md --json
xmemo cloud-skill run <skill-id> --input ./args.json --from skill-view.json --yes --json
Todos los comandos de servicio directo admiten un único sobre JSON legible por máquina. La actualización de conocimiento, la aplicación de Dream y la ejecución de Cloud Skill usan readReceipt de un resultado de lectura/mostrado guardado para que la CLI nunca sustituya silenciosamente una revisión más nueva. Establece XMEMO_KNOWLEDGE_BASE_ID para una base de conocimiento predeterminada no interactiva. Para un elemento de conocimiento largo, continúa con la misma revisión fija con xmemo knowledge read <item-id> --from knowledge-view.json --offset <n>. Ejecuta xmemo doctor --services --json para diagnósticos de solo lectura de Knowledge, Dream y Cloud Skill; deliberadamente no reclama preparación de escritura o producción.
La adición/actualización de Cloud Skill ya apunta a los contratos seguros de solo creación y CAS de contenido. Fallan con SERVER_CONTRACT_REQUIRED en servicios más antiguos y no recurren a rutas de actualización heredadas. Las actualizaciones de elementos de conocimiento binario requieren de manera similar una nueva versión del mismo Documento de servidor; usa --document y --document-version después de que esa versión se haya cargado.
Los ámbitos de inicio de sesión normales permanecen sin cambios. Solicita ámbitos de servicio adicionales explícitamente cuando sea necesario, por ejemplo:
xmemo login --scopes memory:read,memory:write,memory:restore,knowledge:read,knowledge:write
6. Cuenta
xmemo account login [--base-url <url>] [--allow-plaintext] [--json]
xmemo account logout [--yes] [--json]
xmemo account status [--verify] [--base-url <url>] [--json]
xmemo account token status [--verify] [--json]
xmemo account token add --from-stdin --allow-plaintext [--json]
xmemo account token set --from-stdin [--allow-plaintext] [--json]
# Backward-compatible aliases (emit one-line deprecation note on stderr in human mode)
xmemo login
xmemo auth status
xmemo auth-status
xmemo token status
xmemo token add --from-stdin --allow-plaintext
7. Mantenimiento
# Diagnostics and environment validation
xmemo doctor [--services [memory,dream,knowledge,cloud-skill]] [--base-url <url>] [--json]
xmemo doctor --discovery [--base-url <url>] [--json]
xmemo doctor --client <client-id> [--config <path>] [--smoke] [--auth oauth|key] [--fix] [--json]
# Probes, updates, and environment
xmemo status [--url <url>] [--json]
xmemo update [--dry-run] [--json]
xmemo env [--example] [--shell bash|powershell|cmd] [--json]
xmemo privacy [--json]
xmemo --version [--json]
# Safe removal (only XMemo-owned entries and profiles are removed)
xmemo uninstall <client> --dry-run
xmemo uninstall <client> --yes
xmemo uninstall --all --dry-run
xmemo uninstall --all --yes --profiles
# Backward-compatible aliases (emit one-line deprecation note on stderr in human mode)
xmemo smoke --client codex
xmemo discovery show
Ejecuta xmemo help o xmemo <command> --help para opciones completas y coincidentes con la versión.
Notas del cliente
Codex y Cursor
xmemo setup codex
xmemo doctor --client codex --smoke
xmemo setup cursor
Ambas rutas de configuración escriben una entrada MCP con ámbito de usuario y pueden instalar un perfil de comportamiento de memoria con ámbito de marcador. Usa --no-profile para configurar solo MCP. El plugin de marketplace público de Cursor sigue siendo primero OAuth y no contiene configuración de token portador.
Gemini CLI y Antigravity
xmemo setup gemini
xmemo setup antigravity
Estos clientes usan MCP OAuth alojado. Su configuración generada no lleva valor de token; reinicia el cliente y completa el inicio de sesión del navegador en el primer uso.
OpenClaw
xmemo login
xmemo setup openclaw
openclaw xmemo status
El comando de configuración instala o actualiza @xmemo/openclaw-memory, instala la Habilidad XMemo, reutiliza la credencial XMemo compartida y verifica el estado del plugin.
Hermes
xmemo login
xmemo setup hermes
El comando de configuración instala o actualiza hermes-xmemo, configura el proveedor nativo y sincroniza la credencial XMemo con ámbito de usuario con Hermes.
Copilot CLI
xmemo login
xmemo setup copilot
xmemo mcp proxy
Copilot CLI recibe una entrada de proxy local. El proxy lee la credencial del almacenamiento con ámbito de usuario, agrega metadatos de identidad y reenvía solicitudes a MCP alojado sin escribir secretos en la configuración de Copilot.
Seguridad por defecto
| Control | Comportamiento predeterminado |
|---|---|
| Telemetría | Sin analíticas de CLI ni telemetría de uso |
| Salida de credenciales | Los valores de token nunca se imprimen |
| Archivos de proyecto | La configuración generada hace referencia a secretos; no los incrusta |
| Descubrimiento | doctor, discovery show y el descubrimiento público de capacidades no envían token |
| Identidad | Un ID de instancia de agente estable y no secreto se almacena fuera de git |
| Escrituras | La configuración admite vista previa/ejecución en seco; la eliminación amplia requiere confirmación |
| Almacenamiento local de credenciales | El inicio de sesión interactivo pregunta primero; las escrituras no interactivas requieren --allow-plaintext; los tokens almacenados no están cifrados |
| Contenido del paquete | Una lista de permitidos de npm files excluye pruebas, operaciones, registros y código de servidor |
La precedencia de credenciales y los alias de compatibilidad están documentados por:
xmemo env example --shell bash
xmemo privacy
Para implementaciones privadas o autohospedadas, establece XMEMO_URL o pasa --url <service-url>. MEMORY_OS_URL sigue siendo un alias de compatibilidad.
Límite del paquete
Publicado en npm:
bin/
docs/assets/
src/
README.md
LICENSE
No publicado:
.github/
docs/analysis/
docs/architecture/
docs/design/
test/
coverage/
server code
database migrations
deployment files
logs and local state
Desarrollo
npm install
npm run release:check
npm run lint
npm test
npm run pack:dry-run
Antes de proponer un lanzamiento, ejecuta la compuerta completa del paquete:
npm run prepublishOnly
El servidor stdio local se puede inspeccionar directamente:
node bin/mcp-stdio.js
Versionado
Este repositorio distribuye dos productos independientes con pistas de versiones desacopladas:
- CLI (
@xmemo/client): Publicado en npm.- Fuente de versión:
package.json. - Convención de etiquetas:
cli-v*(las etiquetas heredadas hasta la versión 0.4.181 usabanv0.4.xxx). - Ver versiones en npm (@xmemo/client).
- Fuente de versión:
- Skill (
xmemo): Publicado en ClawHub y distribuido a través de xmemo.dev.- Fuente de versión:
skills/xmemo/scripts/xmemo-skill.mjs(SKILL_VERSION). - Convención de etiquetas:
skill-v*. - Ver versiones en ClawHub (xmemo). Los lanzamientos de GitHub para versiones de skill llevan explícitamente la insignia de lanzamiento
Latestpara admitir descargas automáticas de instalador y de respaldo del servidor.
- Fuente de versión:
Modelo de lanzamiento
Los lanzamientos normales son producidos por GitHub Actions desde el commit etiquetado exacto, no desde una rama mutable ni desde una estación de trabajo de desarrollador:
develop → CLI version sync → test → cli-v tag → GitHub Actions → npm publish --provenance
El paquete CLI y el servicio MCP alojado tienen intencionalmente flujos de versión separados:
- Versión CLI/npm:
package.json,package-lock.jsony la entrada del paquete npm enserver.json. - Versión MCP alojado/Registry: el
server.json.versionde nivel superior ylhm.plugin.json. Esta versión sigue al servicio XMemo desplegado.
node scripts/check-release-version.mjs verifica ambos contratos. Una
etiqueta cli-vX.Y.Z debe ser igual a la versión CLI/npm y publica solo npm. El
MCP Registry se publica por separado con el flujo de trabajo Publish MCP Registry metadata
usando mcp-vX.Y.Z, que debe ser igual a la versión MCP alojado/Registry.
El flujo de trabajo separado de publicación npm es solo para recuperación manual, por lo que crear un
lanzamiento de GitHub no puede publicar dos veces. La publicación npm del CLI usa publicación confiable OIDC
(environment: npm, id-token: write); el NPM_TOKEN estático ya no se
usa. La recuperación manual a través de .github/workflows/publish.yml requiere su
propia entrada de editor confiable en npmjs.com.
Documentación y soporte
La documentación canónica del servicio vive en xmemo.dev/docs. Este repositorio documenta el cliente; las páginas siguientes documentan el servicio alojado al que se conecta.
| Inicio rápido | xmemo.dev/docs/quickstart |
| Descripción general de MCP y configuración por cliente | xmemo.dev/docs/mcp/overview |
Referencia de herramientas (remember, recall, search, …) | xmemo.dev/docs/tools/remember |
| API REST | xmemo.dev/docs/api/authentication |
| Solución de problemas | xmemo.dev/docs/troubleshooting |
| Índice legible por máquina | xmemo.dev/llms.txt |
Licencia
MIT © 2025–2026 Yonro
Reparar una configuración MCP de Kiro existente
Ejecute xmemo doctor --client kiro --json para inspeccionar la configuración local sin solicitudes de red.
Use xmemo doctor --client kiro --fix para migrar configuraciones proxy heredadas reconocidas a
OAuth HTTP nativo, o agregue --auth key para HTTP nativo con Bearer ${XMEMO_KEY}. Las reparaciones crean una
copia de seguridad, conservan servidores no relacionados y preferencias del cliente, y nunca copian credenciales en el
reemplazo. Recargue Kiro y verifique una llamada de herramienta real después; una pasada de configuración no es un
resultado de autenticación o renovación de token. Las instalaciones nuevas usan xmemo setup kiro [--auth oauth|key].
