KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

lifeos

★ 37 Open GitHub ↗

Obsidian + AI Agent = LifeOS Your Lifelong Learning System 你的终身学习系统。

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<big><a href="./README.en.md">English</a> | 中文</big>

LifeOS 是一套运行在 Obsidian 之上的 Agent 知识系统：Obsidian 承载纯 Markdown 知识库（本地、可迁移、零锁定），Agent 提供技能、提示词与 MCP 执行引擎，LifeOS 将两者粘合为完整的「捕获 → 研究 → 学习 → 复习 → 归档」闭环。Agent 工具可以更换，但你的记忆与上下文无需重新开始：规则、决策与偏好沉淀在工作空间中，跨 Agent、跨会话持续生效。

### 学习状态首页

`Dashboard.md` 学习状态首页动态展示掌握率 KPI、当月活动热力图、知识生命周期与遗忘曲线，以及待复习笔记、活跃项目清单。需 [Dataview](https://github.com/blacksmithgu/obsidian-dataview) 插件并开启 **Enable JavaScript Queries**（设置 → 第三方插件 → Dataview 齿轮图标 → General 分组勾选），否则动态区块不渲染，仅剩两个 Dataview 表格。

> 学习工作流全流程：灵感 → 研究 → 学习 → 复习 → 归档，记忆系统贯穿全程。

> 记忆系统：7 个 MCP 工具三路分工（读链路 / 写链路 / 治理），写入跨会话生效。

**核心优点**

- **开箱即用**：初始化一次即获得目录结构、技能、模板与记忆系统，无需自行拼装工具链
- **纯 Markdown 承载**：知识以标准 Markdown 存储于本地 Vault，Obsidian 原生兼容，无格式锁定
- **Agent 无关**：Claude Code、Codex、OpenCode、Grok Build 等 6 种客户端开箱即用，切换不丢上下文
- **记忆沉淀**：规则、决策、画像沉淀在工作空间，跨 Agent、跨会话持续生效

## 安装与初始化

```bash
# 第一步：全局安装 CLI
npm install -g lifeos

# 第二步：创建新的 LifeOS 工作空间（根据系统 locale 自动检测语言）
lifeos init ./my-vault

# 或显式指定语言
lifeos init ./my-vault --lang zh   # 中文
lifeos init ./my-vault --lang en   # 英文
```

## 升级

当 LifeOS 发布新版本后，按以下步骤升级已有 Vault：

```bash
# 第一步：更新 CLI 到最新版本
npm update -g lifeos

# 第二步：升级 Vault 资产与脚手架
lifeos upgrade ./my-vault
```

`npm update -g lifeos` 会更新 CLI 和内置资源；`lifeos upgrade` 会自动升级 Vault，并在升级前保留最近一次回滚备份。

### 手动回滚

备份位于 Vault 同级的 `.lifeos-cutovers` 目录。先查找对应的 `journal.json`：

```bash
find /absolute/path/to/.lifeos-cutovers -type f -name journal.json -print
```

然后使用该 journal 回滚：

```bash
lifeos upgrade /absolute/path/to/my-vault \
 --restore /absolute/path/to/.lifeos-cutovers/my-vault-<id>/<cutover-id>/journal.json
```

回滚会替换整个 Vault；请先保存升级后仍需保留的内容。

## 核心功能

### 目录结构

清晰的目录结构是知识学习和研究的基础，LifeOS 围绕「灵感 → 研究 → 学习 → 复习 → 归档」的学习流程设计了 10 个顶层目录：

```
Vault/
├── 00_草稿/          # 无结构知识池，零碎想法随时写入
├── 10_日记/          # 每日日志（YYYY-MM-DD.md）
├── 20_项目/          # 进行中的项目
├── 30_研究/          # 深度研究报告，按 领域/主题/ 组织
├── 40_知识/          # 知识库：体系化笔记 + 百科概念
├── 50_成果/          # 文章、教程、讲稿等可交付输出
├── 60_计划/          # /research 和 /project 的执行计划
├── 70_资源/          # 原始资料：书籍、文献
├── 80_复盘/          # 周期性回顾与系统校准
└── 90_系统/          # 模板、规范、提示词、归档
```

1. `lifeos init` 会自动生成上述默认目录结构。
2. 所有目录名均可通过 `lifeos rename` 自定义。

### 学习工作流

LifeOS 提供一组围绕学习过程设计的 Agent 技能，把”输入 -> 理解 -> 产出 -> 巩固”串成连续工作流：

- `/today`、`/brainstorm`、`/ask`：整理当天重点、澄清问题、快速展开想法
- `/project`、`/research`、`/knowledge`：把主题推进成项目、研究报告和知识笔记
- `/digest`：按主题订阅论文、RSS 与 Web 更新，自动生成结构化信息周报
- `/read-pdf`、`/revise`、`/archive`：从资料提取、复习巩固，到定期归档

知识笔记的掌握状态只按 `draft → review → revised → mastered` 向前推进，不允许降级。

### 记忆系统

LifeOS 当前使用单一最终契约：`contract_version=2` 与 `Schema V4`。MCP 固定暴露 7 个工具，标准调用链如下：

```text
memory_bootstrap
  → 判断 skill、project、repository、tool 或 file scope
  → memory_context
  → 按需 memory_query
  → 执行任务
  → memory_notify / memory_log
```

| 工具 | 触发与调用时机 | 典型技能或场景 |
| --- | --- | --- |
| `memory_bootstrap` | LifeOS 新会话第一步调用一次；压缩上下文恢复，或全局规则、画像、TaskBoard 焦点确实变化时重新调用 | 会话级调用，不属于某个具体技能，也不会每轮重复调用 |
| `memory_context` | 任务完成路由并明确 scope 后，在实际处理前调用；全局信息已由 bootstrap 注入，因此默认使用 `include_global=false` | 所有 LifeOS 技能都会携带自己的 skill scope；已明确项目、仓库、工具或文件时同时加入对应 scope |
| `memory_query` | 需要检索笔记原文、项目状态或知识索引时按需调用，不负责加载局部规则 | `/today` 查询活跃项目和待复习内容，`/revise` 查询 review 笔记，`/archive` 查询已完成条目，`/ask`、`/knowledge`、`/brainstorm` 检索相关资料 |
| `memory_log` | 只在信息需要跨会话持续生效时调用，写入显式 `item_kind`、`scope` 与 `slot_key` | 记录用户长期规则、已确认的项目决策、稳定事实，以及 `/revise` 识别出的强弱项或 `/ask` 确认的稳定偏好；普通问答和一次性事件不写入 |
| `memory_rules` | 需要治理、检查或诊断记忆条目时调用，不参与普通任务的上下文加载 | 查看有效或过期规则、按 scope 或 slot 审计、检查重复项，以及排查某条规则为何生效 |
| `memory_forget` | 明确需要废弃某条记忆，并取得 `item_id` 后调用；必须同时记录原因 | 用户明确要求忘记某条记忆，或审计后确认条目失效；执行软归档，不物理删除 |
| `memory_notify` | 创建、修改、移动或删除 Vault 文件后立即调用；移动或重命名时同时传入旧路径 | `/project`、`/knowledge`、`/today`、`/research`、`/digest`、`/translate`、`/archive` 等所有写入 Vault 文件的流程 |

这里的“自动调用”是指 Agent 根据 `AGENTS.md` 和各技能的 `SKILL.md` 判断场景并发起调用；MCP 工具本身不会脱离 Agent 自主运行。`memory_context` 用于读取当前任务应遵守的局部规则，`memory_query` 用于检索 Vault 中的实际内容，`memory_rules` 用于审计记忆条目本身。

`memory_bootstrap` 是唯一不传 `contract_version`、也是唯一返回 `_layer0` 的工具。其余工具必须传 `contract_version=2`，版本错误会在运行时触碰 Vault 或数据库前被拒绝。

记忆条目以 `(scope.type, scope.key, slot_key)` 为稳定身份。scope 支持 `global`、`skill`、`project`、`repository`、`tool`、`file`；同一 slot 可以在不同 scope 中分别存在。Layer 0 只加载全局规则、画像摘要和当前焦点，局部规则必须通过 `memory_context` 显式请求。

完整字段、优先级、预算、升级与治理说明见 [记忆协议 V2](./docs/memory-contract-v2.md)。

## 快速开始

### 支持的客户端

`lifeos init` / `lifeos upgrade` 会自动注册项目级 MCP 配置。各客户端的配置路径与验证状态如下：

| 客户端 | 配置文件 | 验证状态 |
| --- | --- | --- |
| **Claude Code** CLI | `.mcp.json` | macOS 已验证 |
| **Codex** CLI / Desktop | `.codex/config.toml` | macOS CLI / Desktop、Windows Desktop 已验证 |
| **OpenCode** CLI / Desktop | `opencode.json` | macOS CLI / Desktop、Windows Desktop 已验证 |
| **Grok Build** | `.mcp.json`（兼容加载 Claude Code 格式） | macOS 已验证 |
| **OMP (Oh My Pi)** CLI | `.mcp.json`（兼容加载 Claude Code 格式） | macOS 已验证 |
| **Antigravity** CLI | `.agents/mcp_config.json` | 项目级 MCP 自动注册已支持；平台组合尚未验证 |

在 Vault 目录下启动任一已支持的客户端即可使用全部技能。其他平台或客户端组合尚未验证。

### 前置要求

| 依赖 | 必须 | 用途 |
|---|---|---|
| **Node.js 24.14.1+ (LTS)** | 必须 | MCP Server 和 CLI 运行环境 |
| **Python 3** | 必须 | PDF 提取（`/read-pdf`）和信息周报抓取脚本（`/digest`） |

`lifeos init` 会在创建工作空间前自动检查所有前置依赖。

## CLI 命令

```bash
lifeos init [path] [--lang zh|en] [--no-mcp] # 创建新 Vault
lifeos upgrade [path] # 升级现有 Vault
lifeos upgrade [path] --restore <journal> # 用受控 journal 恢复整个 Vault
lifeos doctor [path] # 健康检查
lifeos rename [path] # 交互式重命名目录
lifeos rules list|audit|export [path] # 只读审计与导出记忆
lifeos rules classify|archive|restore [path] # 显式治理记忆条目
lifeos --help # 查看帮助
lifeos --version # 查看版本
```

## 技能一览

| 技能 | 功能 |
|---|---|
| `/today` | 晨间规划：回顾昨日、规划今日 |
| `/project` | 想法 → 结构化项目 |
| `/research` | 主题 → 深度研究报告 |
| `/digest` | 主题订阅 → 结构化信息周报 |
| `/knowledge` | 书籍/论文 → 知识笔记 |
| `/revise` | 生成复习题、批改、追踪掌握度 |
| `/read-pdf` | PDF → 结构化笔记 |
| `/translate` | 英文 PDF 章节 → 中文对照阅读笔记，支持 PDF++ 双窗口阅读 |
| `/ask` | 快速问答 |
| `/brainstorm` | 交互式头脑风暴 |
| `/archive` | 归档已完成的项目、已处理的草稿、已完成的计划，以及超过最近 7 天的日记 |

## 自定义科研信息周报

`/digest` 技能帮你按主题订阅论文、RSS 和 Web 更新，自动生成结构化信息周报。

### 配置（Setup）

首次使用时，运行 `/digest setup` 进入交互式配置：

1. **定义主题**：输入关注的主题名称和 2–3 个子方向
2. **选择偏好**：说明偏向学术还是产业、有哪些必读来源
3. **生成配置**：Agent 自动推荐 RSS、论文源（arXiv / bioRxiv / SSRN 等）、Web 搜索模板、HuggingFace Papers、GitHub Trending，并写入配置文件
4. **审阅调整**：配置文件保存为 Markdown，你可以在 Obsidian 中直接编辑——切换来源开关、增删 RSS、调整搜索关键词

### 生成周报（Run）

配置完成后，运行 `/digest <主题>` 即可生成周报：

1. **解析配置**：读取主题配置，计算时间窗口（周刊 7 天 / 双周刊 14 天 / 月刊 30 天）
2. **并行抓取**：同时从 RSS + 论文源、Web 搜索、HuggingFace、GitHub Trending 四路获取数据
3. **去重分类**：合并结果、去除重复，按配置的分类体系归入各板块
4. **输出周报**：生成带摘要的结构化周报到草稿目录，标注重点论文和文章

支持多主题并行，每个主题独立配置、独立产出。

## 自定义专家提示词

`/research` 技能会自动扫描 Vault 中提示词目录下的所有专家人格文件。LifeOS 内置了 AI/LLM、数学、艺术、历史等领域的专家人格，你可以添加自己的提示词来扩展研究能力到任何领域。

### 工作原理

调用 `/research` 时，Planning Agent 会：

1. 列出 `{系统目录}/提示词/` 下所有 `.md` 文件
2. 读取每个文件的 frontmatter 和**领域覆盖**章节
3. 将研究主题与最匹配的专家提示词进行比对
4. 将匹配的专家提示词的分析框架和输出格式应用到研究报告中

### 添加自定义专家提示词

在 Vault 的提示词目录（`{系统目录}/提示词/`）下创建 `.md` 文件即可。Planning Agent 在下次 `/research` 调用时会自动发现，无需重启或重新初始化。文件结构参照同目录下的预设提示词即可。

## 技术栈

- **Runtime:** TypeScript + Node.js 24+
- **Protocol:** MCP SDK（@modelcontextprotocol/sdk）
- **Database:** better-sqlite3 + FTS5（全文搜索）
- **Segmentation:** @node-rs/jieba（中文分词）
- **Validation:** Zod（schema 校验）
- **Test:** Vitest
- **Lint:** Biome
- **Vault:** Obsidian（纯 Markdown + Frontmatter）

## 开发

```bash
git clone git@github.com:luneth90/lifeos.git
cd lifeos
npm install
npm run build    # 编译 TypeScript
npm test         # 运行全部测试
npm run dev      # 开发模式（热重载）
```

## License

[MIT](LICENSE)

## 致谢

本项目的灵感来源于 [MarsWang42/OrbitOS](https://github.com/MarsWang42/OrbitOS)。

lifeos

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README