GitHub to OKF
把一个 GitHub 仓库转成 OKF 知识包,并富化成 agent 真正用得上的项目知识。
何时使用
- 用户给一个仓库(
owner/repo或本地路径),想要可检索/可问答的项目知识库; - 想把"散在代码、README、几位核心开发者脑子里"的上下文沉淀下来。
工作流
导入(机械):用
github-to-okf生成基础 bundle。github-to-okf <owner/repo 或 本地路径> -o ./out [--deep]产出仓库总览 + 代码概念(带
language、符号、blob 行级resource)+ 文档概念。富化(AI,关键) —— 按 code-to-okf 约定 提升正文:
- 给
Repository总览补架构图景:核心模块、数据流、关键设计决策; - 给重要
Module/Function补# Behavior(参数/返回/副作用/复杂度)、# Examples; - 补有类型链接:
calls:/depends-on:/implements:,形成调用/依赖图谱。
- 给
取舍:别每个文件都精修;优先公共 API、核心算法、易踩坑处。
校验:
../okf-creator/scripts/validate_okf.py ./out。发布:
okf-to-web(单文件可视化)或okf-to-book(文档站)。
注意
- 远程大仓用
--deep会触发很多请求,先设GITHUB_TOKEN;或先git clone再用本地模式(更快、能拿 blob 行级 resource); resource行号锚点用提交 SHA,代码变动后仍有效;- 符号提取是轻量正则,富化时以实际代码为准、不要编造行为。