waypath
v0.1.1
Published
Local-first external brain CLI for coding agents — SQLite-backed context, graph-aware recall, and governed memory for Claude Code, Codex, and MCP clients.
Maintainers
Readme
[!TIP] 第一次使用?从下方 快速开始 看起。从
npm install到第一次持久化代理会话,大约 60 秒。
什么是 Waypath?
Waypath 是一款面向编码代理和独立开发者的本地优先知识引擎。 它将你的项目决策、实体关系和会话产物保存在单个 SQLite 文件中,并通过一个轻量 CLI 向任意代理宿主 — Claude Code、Codex 或 MCP 客户端 — 提供图感知、真相优先的上下文。
与云端记忆服务不同,Waypath:
- 完全在你本地运行,
- 拥有规范的真相模式(canonical truth schema),而非向量 blob,
- 以显式的 promote + review 关卡对待每一条记忆,
- 作为 77 kB 的 npm 包分发,无需任何运行时服务。
为什么选 Waypath?
| 问题 | Waypath 的答案 |
|---|---|
| 代理跨会话遗忘 | 持久化 SQLite truth kernel |
| RAG 返回无关片段 | FTS5 + RRF 混合排序 + 图扩展 |
| 记忆服务静默幻觉 | 显式 page → promote → review 治理 |
| 云锁定、数据外泄 | 一个本地 .db 文件,完全由你掌握 |
| 每个宿主一套工具 (Claude、Codex、Cursor…) | 单一 facade + 轻量 host shim + 内置 MCP 服务器 |
安装
[!IMPORTANT] 需要 Node.js ≥ 22。Node 22.5+ 可启用原生
node:sqlite驱动;低于此版本会自动回退到better-sqlite3。
npm install -g waypath验证:
waypath --help
waypath source-status --json快速开始
1. 引导一个会话(以 Codex 为例):
waypath codex --json \
--project my-project \
--objective "发布检索管线 v2" \
--task "重构混合排序器" \
--store-path ~/.waypath/my-project.db2. 召回相关上下文:
waypath recall --query "混合排序器决策" --json3. 捕获一条蒸馏洞察并通过 review 升级:
waypath page --subject "混合排序器 v2 设计"
waypath promote --subject "混合排序器 v2 设计"
waypath review-queue --json4. 作为 MCP 服务器运行 (适用于 Claude Code、Cursor、任何 MCP 客户端):
waypath mcp-server --store-path ~/.waypath/my-project.db实际输出示例
$ waypath codex --json --project auth-service \
--objective "迁移到 passkey" --task "设计流程"
{
"host": "codex",
"session_id": "auth-service:passkey-flow",
"context_pack": {
"truth_highlights": {
"decisions": [
"使用 WebAuthn Level 2, 要求 user verification",
"密码回退方案采用 Argon2id 哈希"
],
"entities": ["UserSession", "AuthGateway", "RefreshToken"],
"contradictions": []
},
"recent_pages": [
"会话存储设计 — 2026-04-12 已升级"
]
}
}命令总览
| 分类 | 命令 |
|------|------|
| 会话引导 | codex, claude-code, mcp-server |
| 召回 | recall, explain, graph-query, history |
| Page (蒸馏知识) | page, promote, refresh-page, inspect-page |
| Review 治理 | review, review-queue, inspect-candidate, resolve-contradiction |
| 导入 / 扫描 | import-seed, import-local, scan |
| 健康检查 | source-status, health, db-stats, rebuild-fts |
| 运维 | backup, benchmark, export |
完整帮助: waypath --help.
架构
Waypath 由一个轻量 facade 背后的四个独立 kernel 组成:
flowchart TD
subgraph HOST[" Host Shims "]
direction LR
CX["codex"]
CC["claude-code"]
MC["mcp-server"]
end
Facade["<b>Facade</b><br/><code>createFacade()</code>"]
TK["<b>Truth Kernel</b><br/>decisions · entities · preferences<br/>temporal validity · supersede"]
AK["<b>Archive Kernel</b><br/>evidence · content-hash dedup<br/>FTS5 index"]
ON["<b>Ontology</b><br/>graph traversal<br/>pattern expansion"]
PR["<b>Promotion Engine</b><br/>candidate review<br/>contradiction detection"]
HOST --> Facade
Facade --> TK
Facade --> AK
Facade --> ON
Facade --> PR
classDef kernel fill:#21262d,color:#c9d1d9,stroke:#30363d,stroke-width:1px
classDef facade fill:#1f6feb,color:#ffffff,stroke:#58a6ff,stroke-width:2px
classDef host fill:#161b22,color:#c9d1d9,stroke:#30363d,stroke-width:1px
class TK,AK,ON,PR kernel
class Facade facade
class CX,CC,MC host- Truth kernel — 规范化的 decisions · entities · preferences,带 temporal validity(schema v3)+ supersede + history。
- Archive kernel — 原始 evidence 存储,带 content-hash 去重 + FTS5 全文索引。
- Ontology layer — 用于 entity/decision 扩展的图遍历 (模式:
project_context,person_context,system_reasoning,contradiction_lookup)。 - Promotion engine — 候选评审、冲突检测、supersede 流程。
createFacade() 暴露 14 个 verb,host shim 将其适配到每个代理的引导协议。
配置
Waypath 默认零配置。若要调整检索权重、适配器开关或评审阈值,请在工作目录放置 config.toml,或通过 WAYPATH_CONFIG_PATH 指向一个:
[source_adapters]
jarvis-memory-db = true
jarvis-brain-db = false
[retrieval.source_system_weights]
truth-kernel = 1.2
[retrieval.source_kind_weights]
decision = 0.9
memory = 0.5
[review_queue]
limit = 12通过环境变量覆盖:
export WAYPATH_RECALL_WEIGHT_SOURCE_SYSTEM_TRUTH_KERNEL=1.8
export WAYPATH_REVIEW_QUEUE_LIMIT=8优先级: env override > config.toml > 内置默认值。
MCP 服务器
Waypath 以第二个二进制提供原生 MCP (Model Context Protocol) 服务器:
waypath-mcp-server或通过主 CLI:
waypath mcp-server --store-path ~/.waypath/project.db通过 MCP 暴露的工具: recall, page, promote, review, graph-query, source-status。
环境要求
- Node.js ≥ 22.0 (必需)
- Node.js ≥ 22.5 推荐 — 启用原生
node:sqlite better-sqlite3是可选 fallback,在 22.0–22.4 或原生 sqlite 不可用时自动使用
状态
- 版本: 0.1.0 — 首个公开发布
- 测试: 131 个通过 (单元 + 集成 + 基准)
- 稳定表面: CLI (26 个命令)、MCP 服务器、facade API
- 延期项: 托管部署、多用户同步、自适应排序反馈
与替代方案对比
| | Waypath | 云记忆 (mem0, zep) | 纯向量 RAG | |---|:---:|:---:|:---:| | 本地优先 | ✓ | ✗ | 视情况 | | 规范真相模式 | ✓ | ✗ | ✗ | | 图感知召回 | ✓ | 部分 | ✗ | | 显式 review 关卡 | ✓ | ✗ | ✗ | | 内置 MCP 服务器 | ✓ | ✗ | ✗ | | 一键安装 | ✓ | 需要服务 | 视情况 |
参与贡献
Waypath 欢迎 host shim、source adapter 和 bug 修复。新手可从 此处带标签的 issue 开始。
开发环境、代码风格与 PR 流程请参阅 CONTRIBUTING.md。
提交 PR 前:
npm run build
npm test许可证
MIT © TheStack.ai — 详见 LICENSE.
