okf-generator
将代码库转换为结构化知识包，供AI智能体快速检索理解。
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：okf-generator。 它的用途是：将代码库转换为结构化知识包，供AI智能体快速检索理解。 完整的 Skill 内容见：https://321skill.com/skills/okf-generator/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
当你需要对一个陌生代码库进行开发或向AI解释项目结构时，可以
对AI说：“请使用okf-generator技能，为`./my_project`目录生成OKF知识包。” AI会调用该技能执行静态解析。完成后，你可以继续问：“查找`UserService`这个类的详细定义。” AI会利用`okf lookup`功能，从知识包中精准提取该类的签名、方法、文档等信息并呈现给你。
介绍
OKF Generator & Lookup 是一个专为AI智能体设计的工具，它解决了AI在处理复杂代码库时缺乏结构化上下文知识的痛点。它能够自动扫描Python、JavaScript/TypeScript、Go、Java、Rust、Ruby等多种语言的代码库，通过tree-sitter解析AST，提取其中的函数、类、模块等概念，并生成符合Open Knowledge Format (OKF) v0.2规范的结构化知识包。
使用方式非常灵活，主要通过一个统一的okf命令行工具。核心流程分为三步：首先使用okf generate命令从源代码生成知识包；然后可以利用okf lookup命令在生成的知识包中进行零延迟的精确概念查找，快速回答“某个类/函数是做什么的”这类问题；最后还可以通过okf pairs将知识包转换为JSONL格式的训练数据对，用于微调AI模型。
这个工具非常适合需要让AI深度理解并操作特定代码库的开发者、技术布道师以及AI应用构建者。无论是想为OpenCode、Claude等AI编程助手注入项目上下文，还是希望将私有代码知识转化为可训练的语料，亦或是单纯想为团队创建一个可搜索的代码概念中心，它都能派上用场。
与单纯的代码搜索工具（如grep）或通用文档生成器不同，OKF Generator的核心区别在于其输出是专门为AI消费而设计的结构化“知识包”。它不仅仅生成人类可读的文档，更构建了一个包含概念关系、签名、参数等元数据的语义网络，使得AI智能体能够像人类开发者一样“理解”代码结构并进行精准的上下文检索和注入。
核心特点
核心区别在于其专为AI智能体设计的输出格式（OKF知识包）和零LLM延迟的精确概念查找功能。它生成的不是普通文档，而是包含丰富语义关系的结构化知识图谱，能直接被OpenCode等AI编程助手用于上下文注入，实现“理解代码”而非仅仅“搜索代码”。
注意事项
不适合仅需要简单代码搜索或生成人类阅读的API文档的场景，其价值主要体现在与AI智能体集成的深度工作流中。
常见问题
OKF Generator 和 Doxygen、Sphinx 有什么区别？
Doxygen/Sphinx主要生成人类阅读的API文档网页；OKF Generator生成的是为AI智能体优化的结构化知识包，便于AI快速检索和理解代码概念，并可直接用于上下文注入或训练。
一定要用LLM enrichment吗？
不是必须的。工具支持纯静态解析生成知识包，LLM enrichment是可选项，用于补充缺失的文档字符串和描述，使知识包更丰富。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/okf-generator/raw/index.md 读取 okf-generator 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/okf-generator/raw/index.md（查看排版版本）