wiki

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Wiki

Wiki

Persistent, self-maintained markdown knowledge base for project and session knowledge. Inspired by Karpathy's LLM Wiki concept.
持久化、自主维护的Markdown知识库,用于存储项目与会话相关知识,灵感来自Karpathy提出的LLM Wiki概念。

Operations

操作

Ingest

导入

Process knowledge into wiki pages. A single ingest can touch multiple pages.
wiki_ingest({ title: "Auth Architecture", content: "...", tags: ["auth", "architecture"], category: "architecture" })
将知识处理为wiki页面,单次导入操作可修改多个页面。
wiki_ingest({ title: "Auth Architecture", content: "...", tags: ["auth", "architecture"], category: "architecture" })

Query

查询

Search across all wiki pages by keywords and tags. Returns matching pages with snippets — YOU (the LLM) synthesize answers with citations from the results.
wiki_query({ query: "authentication", tags: ["auth"], category: "architecture" })
按关键词和标签在所有wiki页面中搜索,返回匹配的页面及片段——你(即LLM)可以结合搜索结果中的引用合成答案。
wiki_query({ query: "authentication", tags: ["auth"], category: "architecture" })

Lint

校验

Run health checks on the wiki. Detects orphan pages, stale content, broken cross-references, oversized pages, and structural contradictions.
wiki_lint()
对wiki运行健康检查,可检测孤立页面、过时内容、损坏的交叉引用、过大页面以及结构矛盾。
wiki_lint()

Quick Add

快速添加

Add a single page quickly (simpler than ingest).
wiki_add({ title: "Page Title", content: "...", tags: ["tag1"], category: "decision" })
快速添加单个页面(比导入操作更简单)。
wiki_add({ title: "Page Title", content: "...", tags: ["tag1"], category: "decision" })

List / Read / Delete

列表 / 读取 / 删除

wiki_list()           # Show all pages (reads index.md)
wiki_read({ page: "auth-architecture" })  # Read specific page
wiki_delete({ page: "outdated-page" })    # Delete a page
wiki_list()           # 展示所有页面(读取index.md)
wiki_read({ page: "auth-architecture" })  # 读取指定页面
wiki_delete({ page: "outdated-page" })    # 删除页面

Log

日志

View wiki operation history by reading
.omc/wiki/log.md
.
通过读取
.omc/wiki/log.md
查看wiki操作历史。

Categories

分类

Pages are organized by category:
architecture
,
decision
,
pattern
,
debugging
,
environment
,
session-log
页面按分类组织:
architecture
decision
pattern
debugging
environment
session-log

Storage

存储

  • Pages:
    .omc/wiki/*.md
    (markdown with YAML frontmatter)
  • Index:
    .omc/wiki/index.md
    (auto-maintained catalog)
  • Log:
    .omc/wiki/log.md
    (append-only operation chronicle)
  • 页面:
    .omc/wiki/*.md
    (带YAML前置元数据的Markdown文件)
  • 索引:
    .omc/wiki/index.md
    (自动维护的目录)
  • 日志:
    .omc/wiki/log.md
    (仅追加的操作记录)

Cross-References

交叉引用

Use
[[page-name]]
wiki-link syntax to create cross-references between pages.
使用
[[page-name]]
维基链接语法在页面之间创建交叉引用。

Auto-Capture

自动捕获

At session end, significant discoveries are automatically captured as session-log pages. Configure via
wiki.autoCapture
in
.omc-config.json
(default: enabled).
会话结束时,重要发现会自动作为会话日志页面保存,可通过
.omc-config.json
中的
wiki.autoCapture
配置(默认开启)。

Hard Constraints

硬性约束

  • NO vector embeddings — query uses keyword + tag matching only
  • Wiki pages are git-ignored by default (
    .omc/wiki/
    is project-local)
  • 不使用向量嵌入——查询仅使用关键词+标签匹配
  • Wiki页面默认被git忽略(
    .omc/wiki/
    为项目本地目录)