XMemo

MCP文档知识

提供方 未标注

文档知识 stdio · 本地进程 未标注 社区 / 第三方 Claude DesktopClaudeCursorVS Code
查看接入方式

用户拥有的AI代理远程MCP内存。跨Copilot、Claude、ChatGPT、IDE和CLI保存、搜索、回忆、更新和管理作用域内存。

一句话选型结论

按资料字段整理

XMemo 属于文档知识类 MCP 服务器,stdio · 本地进程,鉴权方式未标注,可直接接入 Claude Desktop、Claude、Cursor 等,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类文档知识 传输方式stdio · 本地进程 鉴权未标注 部署方式本地部署
GitHub 星标 未标注 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

文档知识
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

记忆

安装与配置

stdio · 本地进程 未标注
客户端在本机拉起子进程,数据不出本机
npx @xmemo/client <command>

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Node.js 等运行时,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
文档检索问答

在你的文档库里按问题找答案。

知识库读写

把新资料写进知识库,随用随取。

内容整理

把零散资料归纳成结构化笔记。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude Desktop、Claude、Cursor,换客户端不用重新研究配置。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在文档知识场景里让模型直接调用外部能力的人。
  • 已经在用 Claude Desktop、Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
XMemo当前 未标注 stdio · 本地进程 本地部署 有 未标注
dify 未标注 stdio · 本地进程 本地部署 有 2026-04-11
open-webui 未标注 stdio · 本地进程 本地部署 有 2026-04-11
JeecgBoot 未标注 stdio · 本地进程 本地部署 有 2026-04-11
Cherry Studio 未标注 未标注 未标注 无 2026-05-17
mempalace 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

文档知识
字段来自项目仓库与公开索引,中文说明由本站标注
提供方未标注上游标注的维护方 未标注
分类文档知识本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式未标注远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · 未标注本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验未标注上游最后核验时间

详细介绍

34.7 KB
来自项目仓库与上游目录的原文,未做删改

XMemo: Memory OS for AI Agents

XMemo is a user-owned Memory OS for AI agents: persistent memory, project context and session continuity with agent identity, provenance and governed access, shared across AI clients through MCP, the CLI and a public REST API surface.

English · 简体中文 | Documentation · Hosted MCP


What this repository contains

  • @xmemo/client: the official xmemo CLI for setup, diagnostics, behavior profiles, and memory commands.
  • MCP distribution: hosted Streamable HTTP configuration (https://xmemo.dev/mcp) and the local xmemo-mcp stdio server.
  • XMemo Skill & native integrations: skills/xmemo for agent platforms and the native plugin index (src/plugins/index.json).
  • Marketplace and registry metadata: canonical descriptors for MCP Registry (server.json), LobeHub (lhm.plugin.json), and AI agents (context7.json).

The hosted service implementation is private.

Beyond MCP

MCP is one access surface of XMemo, not the product boundary. XMemo provides a persistent, governed memory operating layer across AI tools and agents:

  • Persistent Memory: store, search, list, and soft-delete durable facts, preferences, and operational knowledge across sessions.
  • Context Recall: retrieve focused, relevant context on demand with token-budget controls and document expansions.
  • Session Continuity & Working State: restart snapshots and state save/restore so agents resume context across process restarts.
  • Project Context & Decisions: track project-scoped facts, TODOs, and durable decisions across agent workflows.
  • Agent Identity & Provenance: track authorship and origin per memory record via agent instance attribution without conflating credentials.
  • Governed Access: scoped tokens, OAuth where the client supports it, soft/hard deletion and sensitive-memory handling (governance details).
  • Native Integrations & Skill: dedicated integration for OpenClaw, Hermes, XMemo Skill (ClawHub), and DeepSeek DSH (available, released and pilot-tested; integration maturity Preview).
  • Access Surfaces: unified via Model Context Protocol, the local CLI (xmemo), and the public REST API.

Preview: Cloud Skills; Dream (off by default); Teams (Business plan not yet available). Knowledge Bases are available where enabled for the account.

XMemo CLI

@xmemo/client is the official control plane for connecting AI tools to XMemo. It makes setup repeatable, keeps credentials out of project files, and gives every supported client a consistent path to durable, user-owned memory.

The package is deliberately small: the CLI runtime, safe client configuration, behavior profiles, XMemo skills, and marketplace metadata. Server code, databases, deployment files, logs, and internal operations remain outside the npm distribution.

Architecture

Package · @xmemo/client
Primary command · xmemo (alias: client)
Local MCP command · xmemo-mcp
Hosted MCP · https://xmemo.dev/mcp
Runtime · Node.js 20 or later
License · MIT

Why XMemo CLI

  • One control plane — login, diagnostics, configuration, profiles, updates,
    and smoke checks share one predictable interface.
  • Private by design — generated project configuration references a
    credential; it never embeds the credential value.
  • Native where it matters — OpenClaw and Hermes use dedicated memory
    integrations instead of duplicating the same capability through MCP.
  • Portable everywhere else — hosted Streamable HTTP MCP and local stdio
    cover modern editors, terminals, and agent runtimes.
  • Safe automation — supported setup and removal paths offer preview,
    dry-run, or explicit confirmation before making changes.
  • Small supply-chain surface — the npm package is governed by an explicit
    file allowlist and release provenance.

Quick start

Guided onboarding (xmemo init)

For an interactive first-run experience across account authentication, detected clients, agent behavior instructions, MCP server setup, skills, and plugins, run:```bash
npm install -g @xmemo/client
xmemo init


Flags and options:
- `xmemo init --dry-run`: View the full onboarding plan without performing network calls or disk writes.
- `xmemo init --yes`: Automatically accept and apply all onboarding steps without interactive prompts.
- `xmemo init --json`: Emit structured JSON for the plan or result envelope.
- `xmemo init --client ...`: Restrict onboarding to specific clients (e.g., `cursor`, `codex`, `claude-code`).
- `xmemo start`: Alias for `xmemo init` with quick-start walkthrough steps.

Global installation exposes `xmemo` as the primary command, and also provides `client` and `memory-os` as aliases.

### Manual step-by-step setup```bash
xmemo account login
xmemo doctor
xmemo setup codex
xmemo status

Replace codex with your client. Preview a configuration before writing it:```bash
xmemo setup cursor --dry-run


### Running with npx

You can also run any CLI command directly without a global install via `npx @xmemo/client `:```bash
# 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]
> Start with xmemo init (or xmemo account login, xmemo doctor, and xmemo setup).
> Hand-edit MCP configuration only when a client has no verified setup path.

How the commands fit together

The XMemo CLI architecture is built on four core design principles:

1. Unified Resource Grammar (xmemo)

Every integration component is a first-class resource with predictable lifecycle actions:

Resource Scope Actions Examples
mcp MCP server connection configuration install, remove, status xmemo mcp install codex, xmemo mcp status
plugin Host-native extension packages install, remove, status, list, info xmemo plugin install gemini-cli, xmemo plugin list
skill Agent skill scripts & documentation install, remove, status, update xmemo skill install --client openclaw
profile Markdown behavior steering instructions install, remove, status, show xmemo profile install cursor
  • Composite commands: xmemo setup [...], xmemo uninstall [...], and xmemo status [] orchestrate these resources in a single step according to the client's declarative profile.
  • Backward-compatible aliases: Familiar commands such as xmemo mcp add (alias for mcp install), xmemo profile uninstall (alias for profile remove), and xmemo skill uninstall (alias for skill remove) remain fully functional and print a helpful one-line hint in interactive terminals.

2. Unified Target Resolver

When no client is explicitly passed, the CLI uses a deterministic three-tier precedence resolution model:
1. Explicit flag or argument: --client, positional client argument, or --all.
2. Calling agent environment: Automatically identifies the calling agent runtime when running inside an agent session (e.g., CLAUDECODE / CLAUDE_CODE_ENTRYPOINT maps to claude-code, and CODEX_THREAD_ID / CODEX_SESSION_ID maps to codex).
3. Detected installed clients: Inspects local configuration paths and markers. If exactly one matching client is found, it is automatically selected; if multiple clients are found in interactive mode, an interactive picker is presented. The CLI never silently writes configuration to arbitrary unverified paths.

3. Plan, Confirm Once, Apply (PlanRunner)

Mutating commands follow a strict, atomic execution pattern:
1. Build Plan: Assemble an ordered sequence of actions across resources (e.g. plugin install followed by skill configuration).
2. Preview: Print the entire plan (including modified paths, commands, and unified diffs) to the terminal.
3. Confirm Once: Prompt [y/N] exactly once for the entire sequence. Re-running with --yes or -y bypasses the prompt; --dry-run displays the preview without mutation.
4. Apply Sequentially: Steps run in dependency order, stopping immediately upon first failure. Re-running an already configured client detects that all components are up to date and reports Nothing to do.

4. Declarative Client Registry

All client configurations, recipes, and capabilities are declared centrally in src/clients/registry.js. Command implementations are purely generic orchestrators with zero hardcoded client ID strings. Platforms can also be added dynamically at runtime via registerClient().

Supported integrations

Client Recommended command Connection
Codex xmemo setup codex Hosted MCP + behavior profile
Cursor xmemo setup cursor Hosted MCP + Bearer Token + behavior profile
Copilot CLI xmemo setup copilot Local authenticated proxy
Gemini CLI xmemo setup gemini Hosted MCP + OAuth
Antigravity xmemo setup antigravity Hosted MCP + OAuth
OpenClaw xmemo setup openclaw Native memory plugin + Skill
Hermes xmemo setup hermes Native memory provider
Kiro xmemo setup kiro Native HTTP OAuth; --auth key for API Key
Grok xmemo setup grok Hosted MCP
Other MCP clients xmemo mcp config --client generic Generated template

The client registry also covers Devin Desktop (formerly Windsurf), Cline, Continue, Claude Desktop,
Claude Code, Kimi Code, Muse Code, Zed, JetBrains, OpenCode, Qwen, Trae, and compatible
MCP hosts. Run xmemo mcp list for the current machine-readable catalog.

For VS Code users looking for the dedicated editor extension, see the yonro/xmemo-vscode repository.
For Cursor users looking for the dedicated plugin, see the yonro/xmemo-cursor-plugin repository.
For Claude users looking for the dedicated plugin, see the yonro/xmemo-claude-plugin repository.

Connection modes

Hosted MCP

The recommended universal path is the XMemo Streamable HTTP endpoint:```text
https://xmemo.dev/mcp


OAuth-capable clients complete authentication in the browser. Other clients
reference `XMEMO_KEY` without copying its value into repository files.

Generic configuration shape:```json
{
  &quot;mcpServers&quot;: {
    &quot;XMemo&quot;: {
      &quot;type&quot;: &quot;streamable-http&quot;,
      &quot;url&quot;: &quot;https://xmemo.dev/mcp&quot;,
      &quot;headers&quot;: {
        &quot;Authorization&quot;: &quot;Bearer ${XMEMO_KEY}&quot;
      }
    }
  }
}

Client configuration keys differ; prefer xmemo setup over copying
this generic example directly.

Local stdio MCP

xmemo-mcp is the dedicated stdio entry point for marketplaces and clients
that launch a local process. Safe discovery exposes 20 tools, three prompts,
and two documentation resources without a token. Tool execution still requires
authentication.

After a global installation:```bash
xmemo-mcp


Install-free MCP configuration:```json
{
  &quot;mcpServers&quot;: {
    &quot;XMemo&quot;: {
      &quot;command&quot;: &quot;npx&quot;,
      &quot;args&quot;: [
        &quot;-y&quot;,
        &quot;--package&quot;,
        &quot;@xmemo/client@latest&quot;,
        &quot;xmemo-mcp&quot;
      ]
    }
  }
}

xmemo mcp serve is equivalent when the CLI is already installed.

Native integrations

OpenClaw and Hermes have dedicated memory providers. Their default setup avoids
installing a second, duplicate XMemo tool surface:

  • OpenClaw: installs the pinned plugin clawhub:@xmemo/openclaw-memory@1.0.18 without --force by default. Re-running setup gracefully detects existing installations; use --force to reinstall or overwrite.
  • Hermes: installs the pinned provider package hermes-xmemo==1.1.3 via pip install without -U.
  • Every install command prints the exact command before executing. Use --dry-run to preview actions without installing.```bash

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


Add hosted MCP only when an explicit fallback is desired:```bash
xmemo setup openclaw --with-mcp
xmemo setup hermes --with-mcp

Use --mcp-only to skip the native integration and install only the hosted MCP
fallback.

XMemo Skill install

The CLI installs the verified XMemo Skill locally into agent skill folders or a target directory:

  • Installs into client skill directories:
  • Claude Code: ~/.claude/skills/xmemo-memory (global) or .claude/skills/xmemo-memory (project with --project)
  • Codex: ~/.codex/skills/xmemo-memory
  • OpenClaw: ~/.openclaw/skills/xmemo-memory
  • All other 21 clients remain null until officially documented.
  • Defaults to the pinned @xmemo/skill@1.1.48 release from npm and verifies tarball integrity (sha512 SRI) before extraction.
  • Override version with --version or explicitly opt into the latest release via --version latest.
  • For air-gapped or offline installations, install from a local directory or packed tarball with --from (optional --integrity).
  • Manage client skills with skill status, skill update, and skill remove.
  • Preview actions without writing files using --dry-run.
  • Safety & Consent:
  • Interactive install prompts [y/N] before writing (Enter, EOF, or empty input cancels) unless --yes is specified.
  • Existing installs refuse overwrite without --force; when --force is used, a backup is created in ~/.xmemo/backups/skills// (outside the agent skills directory).
  • skill remove only removes verified XMemo skill directories, refusing foreign folders, and reports the preserved backup location.```bash

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

Automatically resolve detected client(s) (or specify --client <id>)

xmemo skill install

Install into a custom directory path

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


#### Standalone curl &amp; PowerShell installers

For environments without Node.js or `@xmemo/client`, XMemo provides standalone HTTPS installers at `https://xmemo.dev/skill/install` (POSIX `sh`) and `https://xmemo.dev/skill/install.ps1` (PowerShell).

The installer is **agent-aware** and automatically resolves the correct target directory for your active agent:```bash
# 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.48

# Windows (PowerShell):
# $env:XMEMO_SKILL_AGENT=&quot;claude-code&quot;; irm https://xmemo.dev/skill/install.ps1 | iex
# $env:XMEMO_SKILL_AGENT=&quot;codex&quot;; irm https://xmemo.dev/skill/install.ps1 | iex

> [!TIP]
> Prompt for your AI Agent (copy and paste directly into Claude Code, Codex, or another agent):
>text &gt; Install the standalone XMemo Skill into your skills directory: run the installer from https://xmemo.dev/skill/install (on Windows, https://xmemo.dev/skill/install.ps1) with XMEMO_SKILL_DIR set to your skills directory plus /xmemo-memory. Run the doctor command it prints to verify the installation, then reload your skills and follow the Skill&#x27;s first-run steps. Follow your normal safety checks and do not use elevated privileges. &gt;

Target resolution precedence (first match wins):
1. XMEMO_SKILL_DIR: Installs to the specified directory.
2. XMEMO_SKILL_AGENT=claude-code|codex: Installs to the explicit agent's skills directory (openclaw redirects to openclaw skills install xmemo).
3. Auto-detection: Automatically detects Claude Code (CLAUDECODE=1) or Codex (CODEX_THREAD_ID, CODEX_SESSION_ID, or CODEX_HOME).
4. Home directory discovery: If only ~/.claude or only ~/.codex exists in HOME, selects that agent.
5. Fallback: Installs to ./xmemo-skill with a warning on stderr explaining that AI agents will not automatically load the skill from this directory.

Safety & Replacement:
- Refuses to overwrite existing installations unless XMEMO_SKILL_FORCE=1 is provided.
- When replacing, moves the previous installation to ~/.xmemo/backups/skills//- (safely outside agent skill search paths).
- After installation, prints the absolute install path, the verification doctor command (node /scripts/xmemo-skill.mjs doctor --anonymous), and a prompt to reload your agent.

Agent plugins

The CLI provides a curated, static index of verified agent plugins shipped directly in @xmemo/client. Each entry contains a pinned version, release tag, and exact Git commit SHA resolved at release time.

> ℹ️ Strict Separation Rule: xmemo plugin installs agent plugins only (e.g. @xmemo/openclaw-memory). Skills are installed exclusively via xmemo skill install (e.g. @xmemo/xmemo).

Plugin ID Platform / Agent Kind Status Integration
openclaw OpenClaw native-cli Stable openclaw plugins install clawhub:@xmemo/openclaw-memory@1.0.18 (auto-prompts update if already installed)
hermes Hermes Agent native-cli Stable hermes plugins install xmemo (fallback: python -m pip install hermes-xmemo==1.1.3)
claude-code Claude Code git-dir Preview Pinned Git clone verified against commit 5d0d280 (defaults to ~/.xmemo/plugins/claude-code)
cursor Cursor marketplace Preview Cursor Marketplace plugin
gemini-cli Gemini CLI native-cli Preview gemini extensions install https://github.com/yonro/xmemo-gemini-cli --ref 39e25b185b5157490d1683e4ca8c5c5fb1312a88
kiro Kiro manual Preview Steering rules & Power integration
vscode VS Code manual Preview VS Code extension manual steps (pending marketplace publication)
deepseek-dsh DeepSeek DSH native-cli Preview dsh plugin --profile add dsh-xmemo (requires --profile)
chatgpt-codex ChatGPT / Codex marketplace Preview ChatGPT & Codex extension
cindy Cindy manual Preview Native agent memory integration
codex Codex mcp Preview Dedicated MCP configuration (xmemo setup codex)

Commands:```bash

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>]


**Security &amp; Consent:**
- Only verified plugin IDs from the static index are accepted; arbitrary URLs and unknown IDs are rejected with exit code 2.
- Interactive install always displays the execution plan and requires explicit consent (`[y/N]`, defaulting to Cancel on empty input or EOF).
- `--dry-run` guarantees zero disk writes and zero spawned processes.
- Marketplace and manual plugins display exact step-by-step instructions from the plugin repository during `plugin install ` (pass `--open` to open docs in browser).
- Git directory plugins (`claude-code`) clone into a stable per-user location (`~/.xmemo/plugins/`), support `--dir ` override, verify the checked-out `HEAD` commit byte-for-byte, and output the exact load command (`claude --plugin-dir `). On commit mismatch, the directory is immediately removed.
- Plugin child processes run in an isolated environment with authentication tokens (`XMEMO_KEY`, `MEMORY_OS_MCP_TOKEN`, `XMEMO_TOKEN`) scrubbed from argv and env.

## Account and authentication

### Account commands

Manage local authentication, stored credentials, and tokens through the `account` command family:```bash
# 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 &#x27;%s\n&#x27; &#x27;your-token&#x27; | 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

Safe account logout (xmemo account logout)

  • Target removal: Removes only the user-scoped credential file owned by the CLI (~/.config/xmemo/credentials.json or OS config root).
  • Explicit confirmation: Displays the target credential path and prompts Proceed with logout? [y/N] (defaulting to No) unless --yes is specified.
  • Client & Agent Isolation: Preserves all client MCP configuration files (Cursor, Claude, VS Code, etc.) and agent-managed OAuth sessions.
  • Privacy: Never displays or leaks token values in stdout, stderr, or JSON envelopes.
  • Scripting: Requires --yes when --json is specified to prevent accidental headless logout.

Legacy authentication aliases

The legacy commands remain fully supported as backward-compatible aliases:
- xmemo login (alias for xmemo account login)
- xmemo auth status (alias for xmemo account status)
- xmemo auth-status (alias for xmemo account status)
- xmemo token (alias for xmemo account token)

In interactive human mode, legacy aliases emit a one-line deprecation hint to stderr. When run with --json or --help, the deprecation hint is suppressed.

Existing token import

Pipe an existing token through stdin so it does not appear in command history:```bash
printf '%s\n' 'your-token' | xmemo account token add --from-stdin --allow-plaintext
xmemo account token status --verify


PowerShell:```powershell
$xmemoToken = Read-Host &quot;XMemo token&quot;
$xmemoToken | xmemo account token add --from-stdin --allow-plaintext
Remove-Variable xmemoToken

For CI and managed workstations, expose XMEMO_KEY through the platform's
secret manager. Do not commit it to .env, MCP configuration, logs, issue
reports, or chat transcripts.

Universal --json output

Every command and subcommand supports --json for predictable scripting:
- On success: Outputs valid JSON on stdout with exit code 0.
- On error: Outputs a structured JSON error envelope { schemaVersion, ok: false, command, data: null, error: { code, message, ... } } on stdout with a non-zero exit code (e.g. exit code 2 for usage/input errors, 1 for internal/network errors).

Command reference

  1. Get started```bash
    xmemo init [--client <id>...] [--yes] [--dry-run] [--json]

Backward-compatible alias

xmemo start [--json]


2. Connect agents```bash
# High-level client configuration
xmemo setup &lt;client&gt; [--url &lt;url&gt;] [--no-profile] [--json] [--force]
xmemo setup &lt;client&gt; --dry-run
xmemo setup --all [--write] [--profile] [--force]

# Direct MCP server configuration
xmemo mcp serve
xmemo mcp list
xmemo mcp config --client &lt;client-id&gt; [--base-url &lt;url&gt;] [--json]
xmemo mcp add &lt;client-id&gt; [--write] [--config &lt;path&gt;]
xmemo mcp proxy [--port 8765] [--base-url &lt;url&gt;]

# Workspace behavior profiles
xmemo profile install &lt;client-id&gt; [--target &lt;path&gt;] [--dry-run]
xmemo profile show &lt;client-id&gt; [--target &lt;path&gt;] [--json]
xmemo profile status &lt;client-id&gt; [--target &lt;path&gt;] [--json]
xmemo profile uninstall &lt;client-id&gt; [--target &lt;path&gt;] [--yes]
  1. Skill```bash

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```bash
xmemo plugin list [--all] [--json]
xmemo plugin info &lt;id&gt; [--json]
xmemo plugin install &lt;id&gt; [--dry-run] [--yes] [--open] [--dir &lt;path&gt;] [--json]
xmemo plugin status [&lt;id&gt;] [--all] [--json]
  1. Memory```bash
    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


All direct service commands support a single machine-readable JSON envelope.
Knowledge update, Dream apply, and Cloud Skill run use the `readReceipt` from a
saved read/show result so the CLI never silently substitutes a newer revision.
Set `XMEMO_KNOWLEDGE_BASE_ID` for a non-interactive default knowledge base.
For a long knowledge item, continue the same fixed revision with
`xmemo knowledge read  --from knowledge-view.json --offset `.
Run `xmemo doctor --services --json` for read-only Knowledge, Dream, and Cloud
Skill diagnostics; it deliberately does not claim write or production readiness.

Cloud Skill add/update already target the safe create-only and content-CAS
contracts. They fail with `SERVER_CONTRACT_REQUIRED` on older services and do
not fall back to legacy upsert routes. Binary Knowledge item updates similarly
require a new version of the same server Document; use `--document` and
`--document-version` after that version has been uploaded.

The normal login scopes remain unchanged. Request additional service scopes
explicitly when needed, for example:```bash
xmemo login --scopes memory:read,memory:write,memory:restore,knowledge:read,knowledge:write
  1. Account```bash
    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. Maintenance```bash
# Diagnostics and environment validation
xmemo doctor [--services [memory,dream,knowledge,cloud-skill]] [--base-url &lt;url&gt;] [--json]
xmemo doctor --discovery [--base-url &lt;url&gt;] [--json]
xmemo doctor --client &lt;client-id&gt; [--config &lt;path&gt;] [--smoke] [--auth oauth|key] [--fix] [--json]

# Probes, updates, and environment
xmemo status [--url &lt;url&gt;] [--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 &lt;client&gt; --dry-run
xmemo uninstall &lt;client&gt; --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

Run xmemo help or xmemo --help for complete, version-matched
options.

Client notes

…(正文过长,页面只展示前面部分,完整内容见仓库)

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
XMemo 怎么安装?

在客户端按下面的安装命令接入:npx @xmemo/client <command>。装完在客户端配置里引用同一个包或端点。

XMemo 怎么在 Claude Desktop、Claude、Cursor 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

XMemo 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

XMemo 需要 API Key 吗?

资料没有标注鉴权方式,是否需要密钥取决于服务本身,接入前按官方文档确认。

XMemo 支持哪些客户端?

资料标注支持 Claude Desktop、Claude、Cursor、VS Code、Windsurf、Cline;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

XMemo 能提供哪些能力?

资料显示能力标签包括 记忆。具体工具清单以官方文档为准。

XMemo 需要什么运行环境?

属于本地进程,需要在本机装好运行环境。

XMemo 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 未标注。