文档导航
文档/安装/快速安装

快速安装

使用安装器通过 Docker 启动 Lore,或把客户端连接到已有的 Lore 服务器。

如果你想最快得到一个可用的 Lore 服务器和本机 Agent 集成,使用安装器。

前置条件

  • Docker 并带 Compose 插件(docker compose)。macOS 上 Docker Desktop 已包含两者。Linux 上需安装 Docker Engine 和 docker compose 插件。
  • 至少一个要连接的 Agent 运行时(Claude Code、Codex、Pi、OpenClaw、Hermes 或 OpenCode)。OpenCode 预发布集成已用 OpenCode 1.18.3 验证。
  • 一个 OpenAI 兼容的 API key 用于 embedding(例如 OpenAI、DeepSeek 或本地服务)。安装完成后在 /setup 中配置。没有它,语义召回和 Dream 无法工作。

运行安装器

默认安装会用 Docker Compose 启动 Lore,写入本机客户端配置,并配置这台机器上支持的 Agent 渠道。

*.bash
Shell
npx @loremem/cli

中文安装器:

*.bash
Shell
npx @loremem/cli --lang zh

安装器做了什么

  • 从 Lore 仓库下载 docker-compose.yml.env 模板。
  • 启动 Lore 服务器、PostgreSQL 和 Redis 容器。
  • 等待服务器健康检查通过。
  • 创建 ~/.lore/config.json,写入服务器 URL 和 token。
  • 为使用 MCP/hooks 的选中 Agent 渠道安装对应配置。
  • 对 OpenCode,下载 lore-opencode.zip,并原子安装受管理的原生插件到 ~/.config/opencode/plugins/lore-memory.js
  • 安装轻量生命周期转发器;boot guidance 和 recall 格式由 Lore server 返回。

OpenCode 标准安装不会配置 MCP。OpenCode 使用精确命名的原生 lore_* 工具;通用 /api/mcp 仅作为手动兜底。

原生插件会在运行时抑制重复 Lore MCP 导入。安装器还会处理 Claude 兼容层更早载入生命周期 hook 的重复路径:仅当检测到已有且可安全解析的用户级 oh-my-openagent.json[c] 或旧版 oh-my-opencode.json[c] 时,才设置 claude_code.plugins_override["lore@lore"] = false。该操作保留所有无关字段和 JSONC 注释,在 ~/.lore/ 中记录原值,并在卸载 OpenCode 集成时恢复原值。

Lore 不会修改 Claude Code 文件,也不会创建 oh-my-openagent 配置文件;如果现有第三方配置不安全或无法解析,安装器会警告并跳过兼容修改。只有明确需要让旧版 MCP 与原生插件并存时,才在运行安装器和启动 OpenCode 时都设置 LORE_OPENCODE_ALLOW_MCP=1;使用该逃生开关重新安装会恢复 Lore 之前修改的值。

安装完成后可以查看 ~/.lore/ 目录确认写入了哪些文件。

常用选项

选项什么时候用
--channels claudecode,codex只安装选中的集成。OpenCode 使用 opencode
--base-url http://host:18901Lore 已经在别处运行。这个选项会跳过服务器启动。
--api-token TOKEN服务器启用了 API_TOKEN
--skip-docker只安装本机客户端集成。
--pre使用 pre-latest 发布通道。
--dev使用 dev-latest 发布通道。
--force即使版本看起来已是最新,也重新安装。

示例

只安装 OpenCode 预发布版 v1.3.15-pre.4

*.bash
Shell
npx @loremem/cli install --lang zh --pre --channels opencode

该命令为 OpenCode 1.18.3 或更新版本安装 lore-opencode.zip。如果系统未安装 opencode CLI,该 channel 会成功跳过,而不会导致整个安装器失败。

只安装 Codex 和 Claude Code 集成:

*.bash
Shell
npx @loremem/cli install --channels codex,claudecode

把这台机器的 Agent 指向已有 Lore 服务器:

*.bash
Shell
npx @loremem/cli install --base-url http://192.168.1.100:18901 --api-token YOUR_TOKEN

安装后做什么

  1. 如果不是连接已有服务器,打开 http://127.0.0.1:18901/setup
  2. 完成 embedding、View LLM 和 boot memory 设置。
  3. 重启刚安装集成的 Agent 运行时。
  4. Codex 用户运行 codex mcp list 确认 Lore 已注册,然后打开 Codex 会话输入 /hooks,如果提示确认,信任 Lore hooks。
  5. OpenCode 用户确认 ~/.config/opencode/plugins/lore-memory.js 存在,重启 OpenCode,并要求它调用 lore_status。Boot 使用 experimental.chat.system.transform;prompt Recall 使用 chat.message,即使 system 注入不可用也会继续工作。
  6. 发一个真实任务 prompt,确认能看到召回块。

如果你不想让安装器管理服务器或客户端,使用 手动配置

手动配置不使用安装脚本时,手动配置 Lore 服务器和 Agent 集成。使用自己的 PostgreSQL让 Lore 连接已有 PostgreSQL 实例,并配置 pgvector 与可选中文全文搜索扩展。首次运行设置打开 /setup,配置模型端点,初始化启动记忆,并重启已连接的运行时。关键设置配置日常运行需要的服务器认证、Embedding、View LLM、Redis 缓存和备份默认值。