メニュー
把一个 GitHub 仓库(远程或本地)转换并富化为符合 OKF v0.2 的知识包(bundle), 让仓库的文档与代码成为 AI 智能体可检索的知识. 适用场景包括为开源项目生成知识库, 把代码仓库变成 agent 可问答的上下文, 建立仓库的架构与 API 知识图谱. 当用户提到 github to okf, 把仓库转 OKF, 为某个 repo 生成知识库, 或导入某个 GitHub 项目为知识时触发.
デフォルトでは、最初にソースを確認する Prompt が選択されています。直接コマンドに切り替えるか、ローカルコピーをダウンロードすることもできます。
インストールを決める前に、SKILL.md と SkillsMP に表示されている付属ファイルをお読みください。
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
直接コマンドでは確認用 Prompt が省略されます。実行前にソースを確認してください。
npx skills add https://github.com/yzfly/awesome-okf --skill github-to-okfコマンドは1行のまま表示されます。コピー前に横へスクロールして全体を確認してください。
ローカルで確認しますか？SkillsMP が現在取得できるファイルをダウンロードできます。
SKILL.md を表示中
把 GitHub 上的 awesome-xx 精选列表转换并富化为符合 OKF v0.2 的知识包(bundle), 让社区海量教程和资源列表成为 AI 智能体可检索的知识. 适用场景包括把某个 awesome 列表导入为 OKF, 为列表里的条目补充结构化正文, 校验产物符合性. 当用户提到 awesome 列表, GitHub 精选列表转 OKF, 或想把某个 awesome-xx 变成知识库时触发.
把长文, 书稿, 讲义或系列文章拆解为符合 OKF v0.2 的知识包(bundle), 按章节, 概念, 人物, 术语建立互链的概念页. 适用场景包括把一本书或长文档转成结构化知识库, 为写作素材建立可检索的概念网络, 把教程系列整理为 OKF. 当用户提到把书或长文转成 OKF, 拆书, 建立读书知识库, 或为书稿建概念库时触发.
把源代码仓库转换为符合 OKF v0.2 的知识包(bundle), 用一套代码表示约定(类型词表, language/symbol/signature 字段, 行号锚点, 有类型链接)弥补 OKF 对代码的薄弱支持. 适用场景包括为代码库生成 agent 可读的知识文档, 把仓库的模块函数类整理为概念库, 建立代码知识图谱. 当用户提到 code to okf, 代码库转 OKF, 为代码生成知识, 或把仓库变成 agent 可检索的知识时触发.
| name | github-to-okf |
| description | 把一个 GitHub 仓库(远程或本地)转换并富化为符合 OKF v0.2 的知识包(bundle), 让仓库的文档与代码成为 AI 智能体可检索的知识. 适用场景包括为开源项目生成知识库, 把代码仓库变成 agent 可问答的上下文, 建立仓库的架构与 API 知识图谱. 当用户提到 github to okf, 把仓库转 OKF, 为某个 repo 生成知识库, 或导入某个 GitHub 项目为知识时触发. |
| type | Skill |
| title | GitHub to OKF |
| lang | zh |
| tags | ["okf","github","code","skill"] |
| license | MIT |
把一个 GitHub 仓库转成 OKF 知识包,并富化成 agent 真正用得上的项目知识。
owner/repo 或本地路径),想要可检索/可问答的项目知识库;导入(机械):用 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,代码变动后仍有效;