oh-my-memory
v2.1.13
Published
面向 Claude Code 的文件型知识系统 - 零外部依赖,基于本地 Markdown 与平铺索引
Downloads
2,332
Maintainers
Readme
oh-my-memory (omm)
面向 Claude Code 的文件型知识系统。npm CLI 工具,零外部依赖,基于本地 Markdown 文件与平铺索引,实现可检索、可归档的项目知识沉淀,并附带一套可直接复用的全局 Skills。
安装
npm install -g oh-my-memoryCLI 命令
bin 名称:oh-my-memory 和 omm(等价)
| 命令 | 说明 |
|------|------|
| omm kg | 初始化或更新当前项目的知识库环境 |
| omm cc | 部署全局 CLAUDE.md 配置到 ~/.claude/CLAUDE.md |
| omm sk | 同步全局 Skills 到 ~/.claude/skills/ |
omm kg — 初始化项目知识库
在当前项目根目录执行,完成以下操作:
- 创建
.knowledge/目录结构与初始文件 - 将
knowledge-system和knowledge-import两个 skill 复制到.claude/skills/ - 处理
.gitignore(可选择忽略知识库文件)
cd your-project
omm kg
# 或不安装直接使用:
npx omm kgomm cc — 部署全局 CLAUDE.md
将内置的全局行为配置部署到 ~/.claude/CLAUDE.md。该配置包含语言设定、subagent 委派策略、沟通风格等 Claude Code 全局行为规则。已存在时会询问是否覆盖。
omm ccomm sk — 同步全局 Skills
将内置的全局 Skills 同步到 ~/.claude/skills/,支持全量替换或仅更新同名 skill。
omm sk知识库目录结构
omm kg 在项目根目录创建以下结构:
.knowledge/
├── index.md # 平铺索引,记录所有知识条目的路径与摘要
├── todo.md # 待办清单,记录待处理的知识库维护任务
├── docs/ # 项目技术文档
├── code/ # 代码实现记录(含函数签名锚点)
├── refs/ # 外部知识参考
└── dev-logs/
└── progress.md # 开发进度索引
.claude/skills/
├── knowledge-system/ # 主 skill:查询、写入、研究、日志、整理
└── knowledge-import/ # 导入 skill:批量文档导入项目级 Skills
通过 omm kg 部署到 .claude/skills/,在项目内通过斜杠命令调用。
knowledge-system — 项目知识库主 skill
单 worker subagent 架构,自动识别意图,覆盖全部知识库操作场景。
| 场景 | 示例 |
|------|------|
| 查询 | /knowledge-system 查一下认证方案 |
| 写入 | /knowledge-system 把刚才的结论沉淀到知识库 |
| 研究 | /knowledge-system 调研 RS256 和 HS256 的区别 |
| 日志 | /knowledge-system 记录今天的进度 |
| 删除 | /knowledge-system 删除 JWT 中间件那篇 |
| 整理 | /knowledge-system 全量整理 |
knowledge-import — 批量导入 skill
将本地文档目录批量导入到项目知识库。
/knowledge-import docs/全局 Skills
通过 omm sk 部署到 ~/.claude/skills/,在所有项目中可用。
| Skill | 说明 |
|-------|------|
| find-skills | 帮助发现和安装 agent skills |
| frontend-design | 生产级前端界面设计 |
| npm-publish | 发布包到 npm 仓库 |
| skill-creator | 创建、修改、评测 skills |
| ui-ux-pro-max | UI/UX 设计智能(多栈、多风格) |
知识文档规范
- 文档使用 Frontmatter 声明元数据:
summary、created、updated - 索引格式:
path — 一句话摘要 - 分类目录:
docs/(项目文档)、code/(代码实现)、refs/(外部参考)
License
MIT
