ai-memex-cli AGENTS.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

项目概述

ai-memex-cli（命令名 memex）是一个用于构建和维护持久化 LLM wiki 的 CLI 工具。它的核心定位是“机械层”：只做文件操作、frontmatter 校验、关键词匹配、链接检查等纯机械工作；所有语义决策（写什么内容、如何综合知识）都交给外部 LLM agent 通过 shell 调用来完成。

技术栈

• 运行时：Node.js >= 20
• 语言：TypeScript 5.4（严格模式 strict: true）
• 模块系统：ES Modules（"type": "module"），内置模块导入需带 node: 前缀
• CLI 框架：cac
• 测试框架：vitest（globals: true，environment: 'node'）
• 依赖库：gray-matter、chokidar、picocolors
• 包管理器：pnpm
• 构建工具：tsc 直接编译，输出到 dist/

编码规范

• 文件命名：命令文件使用 kebab-case（如 link-check.ts），模块文件使用 camelCase（如 wiki-index.ts）
• 导出约定：每个命令文件导出 *Command 异步函数（如 distillCommand）；核心模块导出具体函数而非默认导出
• 类型命名：接口/类型使用 PascalCase（如 DistillOptions、WikiPage）
• 导入顺序：Node 内置模块（带 node: 前缀）→ 第三方依赖 → 项目内部模块
• 路径风格：内部统一使用正斜杠（/），normalizePath() 处理 Windows 反斜杠
• 禁止项：禁止引入与现有设计重复的大型框架

项目结构

src/
  cli.ts              # CLI 入口，使用 cac 注册所有命令
  commands/           # 各命令实现（init、distill、ingest、watch、glob、inject、lint、search、new、log、install-hooks、status、link-check）
  core/               # 核心领域逻辑（无 side effect 的纯函数优先）
    vault.ts          # Vault 路径解析
    config.ts         # 配置读写（~/.llmwiki/config.json）
    schema.ts         # Frontmatter 解析与校验
    wiki-index.ts     # Wiki 页面索引构建、[[link]] 提取
    globber.ts        # 关键词评分与页面筛选
    linker.ts         # 孤儿页、断链检测
    distiller.ts      # JSONL 解析与机械提取
    injector.ts       # @include 指令解析
  utils/
    fs.ts             # 文件系统封装（readFileUtf8、writeFileUtf8、listMarkdownFiles 等）
    exec.ts           # 子进程调用封装
    logger.ts         # 终端日志（info / success / warn / error）
templates/            # AGENTS.md 与 wiki 页面模板（concept、entity、source、summary）
tests/
  core/               # 核心模块单元测试
  fixtures/
    mock-vault/       # 完整 mock vault 结构，供测试使用
docs/                 # PRD 与设计文档
dist/                 # tsc 编译输出（.gitignore 忽略）

Vault 目录规范

Vault 分两层：默认 wiki（~/.llmwiki/，旧版可能仍为 ~/.llmwiki/global/）与 local（<project>/.llmwiki/local/）。所有路径在 CLI 内部统一归一化为正斜杠。