Read Code

SKILL开发
开发 未标注权限 许可证不明确

读取并理解项目代码,输出一个自包含的 HTML 代码地图(代码结构、模块职责、调用链路、关键逻辑),辅助快速上手与讲解演示

一句话选型结论

按资料字段整理

Read Code是开发类的 Agent Skill,安装方式:GitHub 仓库,权限级别未标注,许可证不明确,没有现成安装命令,需按说明手动放置 SKILL.md。技能本质是给模型读的说明书,效果取决于模型与客户端;装完先用一个小任务验证,再放进正式流程。

分类开发 安装方式GitHub 仓库 权限级别未标注权限 许可证许可证不明确
累计安装 未标注 本周 未标注
GitHub 星标 未标注 仓库 aaaazogh
下载量 未标注 技能市场下载数
权限级别 未标注权限 安装前请确认风险范围
许可证 许可证不明确 未说明

安装

GitHub 仓库
在支持 Skills 的客户端里执行,装完问一句「你有哪些技能」验证
  1. 1
    确认客户端支持

    确认你的客户端支持 Skills(Claude、Codex、Cursor 等),并升级到较新的版本。

  2. 2
    拿到技能文件

    按安装说明或仓库 README,把 SKILL.md 放到客户端的 skills 目录(一般一个技能一个文件夹)。

  3. 3
    刷新技能列表

    重新打开客户端,或刷新技能列表,让新放进来的技能被加载。

  4. 4
    验证是否生效

    问一句「你有哪些技能」,确认列表里出现它,再拿一个小任务试跑。

技能档案

开发
字段来自技能仓库与公开索引,中文说明由本站标注
作者 / 维护方nlp-jvuun仓库 aaaazogh · 版本 未标注
宿主客户端未标注技能可被这些客户端加载
安装方式GitHub 仓库安装包 nlp-jvuun/aaaazogh
权限级别未标注权限安装前请确认风险范围
许可证未说明许可证不明确,商用前请自行确认条款
仓库可用性available技能仓库当前是否可访问
最近核验未标注上游最后核验时间 · 数据更新 2026-08-06
正文体量4.4 KBSKILL.md 原文大小,越大说明说明书写得越细

典型使用场景

3 类
按分类整理的常见用法,具体以 SKILL.md 为准
写代码与改 bug

按需求补代码、定位并修掉报错。

读仓库与生成改动

让模型读懂项目结构,再给出可落地的改动。

跑测试与排查故障

按现象排查问题,补测试用例并复跑。

选择建议

装之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 基础信息齐全,可以先按说明装一个试试。

先想清楚的地方

  • 没有标注权限级别,实际能做什么要装好后确认。
  • 许可证不明确,商用或二次分发前先到仓库确认条款。
  • 没有现成安装命令,要按安装说明或仓库 README 手动放置。
  • 没有做站内核验,内容以作者仓库为准。
  • 技能只是说明书,实际效果取决于模型与客户端,装完先用小任务试一遍。

更适合

  • 需要在开发场景里给模型补一套做法的人。
  • 愿意先读一遍 SKILL.md、确认它会让模型做什么的人。

不太适合

  • 对许可证要求很严、必须明确可商用的人。
  • 只想装完就自动变强、不打算看说明书的人。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
技能权限级别安装方式累计安装宿主客户端安装命令
Read Code当前 未标注权限 GitHub 仓库 未标注 未标注 无
技能审查员 浏览器控制 ClawHub 市场 877.9 万 OpenClaw 有
Vercel React 最佳实践 浏览器控制 GitHub 仓库 849.1 万 Codex、Claude、Cursor 有
GitHub 代码协作 联网访问 ClawHub 市场 763.3 万 OpenClaw 有
网页设计指南 联网访问 GitHub 仓库 668.6 万 Codex、Claude、Cursor 有
本体论 只读 ClawHub 市场 663.7 万 OpenClaw 有

SKILL.md 全文

4.4 KB
模型实际读到的说明书原文,来自技能仓库

read-code — 代码结构与逻辑梳理

读取项目(或指定目录/文件)的代码,输出自包含 HTML 代码地图,讲清「模块组成、协作方式、核心逻辑」。
产物面向人快速理解代码,不是 API 参考文档。

触发条件

用户意图匹配以下任一(同类表达皆可)即触发:

  • 看项目 / 讲代码结构
  • 梳理代码库、出一份文档
  • 项目怎么跑起来 / 入口在哪
  • 核心逻辑是什么 / 想改应该动哪里
  • 生成代码地图 / 架构说明

工作流程

顺序:先全貌 → 后局部 → 再链路。

  1. 摸底:读 README / CLAUDE.md + 工程配置(package.json / requirements.txt / pyproject.toml / go.mod),列目录树(排除 node_modules / .git / __pycache__ / 构建产物),定技术栈、依赖、启动方式。
  2. 入口:定位 main / 路由注册 / 启动脚本 / 构建入口;记录启动命令、端口、必需环境变量。
  3. 模块职责:逐个核心目录/文件标注「负责什么、不负责什么」;关键文件记路径 + 行号 + 核心函数 + 对外接口。
  4. 调用链路:从入口走一遍主流程,记录数据/控制流经过的模块顺序,识别分层、依赖方向、有无循环依赖。
  5. 关键逻辑:核心算法、易错点、边界/异常分支;能用 git log / 注释确认「为什么」就查,查不到不猜。
  6. 产出 HTML:按下述规范生成自包含 HTML 文件并保存,告知用户路径。

> 预算控制(省 token / 少调用,贯穿全程):
> - 先定粒度:文件数 <30 逐文件;30~100 按模块讲;>100 只讲骨架 + 重点模块,避免平铺。
> - 优先读入口与大文件:用 wc -l / ls -S 定位最大文件;入口与高扇入文件精读,其余只扫关键段。
> - 片段读取而非整读:大文件用 grep / head -N / sed -n 只读关键段;生成/数据文件(lock、dist、min.js、长 SQL、测试夹具)跳过。
> - 并行读:相互独立的文件在一条消息内并发 Read,减少往返。
> - 链路通则停:主流程走通即收尾,不追求读完所有文件;确有疑点才追加查询。

HTML 输出规范

  • 单文件自包含:CSS 内联,无外链 CDN / 字体 / 脚本,可离线打开;&lt;!DOCTYPE html&gt; + &lt;html lang=&quot;zh-CN&quot;&gt; + UTF-8。
  • 命名:默认 {项目名}-code-map.html,存项目根目录或用户指定路径;写完后告知路径。
  • 页面自上而下:
    1. 页头:项目名、一句话简介、技术栈标签、运行方式(启动命令)
    2. 目录结构:带职责注释的目录树(关键节点标文件/行号)
    3. 模块清单:表格,文件/模块 → 职责 → 关键函数/入口 → 备注
    4. 调用链路:编号步骤;复杂时配简单 SVG 流程图(入口到出口,标清数据流方向)
    5. 关键逻辑:核心算法/易错点拆解 + 代码片段引用(标 文件:行号)
    6. 扩展指南:「想改什么 → 改哪里」对照表,每行对应真实文件行号
  • 导航与样式:左侧固定 TOC 锚点跳转;长内容用 &lt;details&gt; 折叠;简洁干净(系统字体栈、单一强调色、浅色背景);支持浏览器 Ctrl+F;@media print 隐藏侧边栏。
  • 模板:结构参照 assets/code-map-template.html——仅在生成 HTML 时按需读取,不必每步加载。

质量要求

  • 忠于代码:每个结论有代码依据;不确定标「待确认」,不臆测。
  • 结构优先、可扫读:表格 / 列表 / 编号步骤优先,段落克制。
  • 粒度得当:小项目逐文件讲,大项目按模块分层。
  • 代码引用与真实代码一致,不编造文件 / 行号 / 逻辑。

边界与禁忌

  • 不读 node_modules / .git / 构建产物;超大文件只读关键片段。
  • 不编造代码内容与调用关系;拿不准的链路标「待确认」。
  • 不写成 API 参考文档——只回答「结构是什么、怎么协作、改哪里」。

<!-- v2: 文案压缩(token↓)、HTML 模板外置按需读取、新增预算控制(粒度分级/片段读取/并行读/链路通则停) -->

常见问题

5 问
答案由本站依据条目字段整理
Read Code怎么安装?

没有现成安装命令:按安装说明或仓库 README,把 SKILL.md 放进客户端的 skills 目录(一般一个技能一个文件夹)。

Read Code支持哪些客户端?

资料没有标注宿主客户端,但只要客户端支持 Skills(Claude、Codex、Cursor 等),一般都能加载。

Read Code权限高吗,安全吗?

权限级别为未标注权限。安装前先看它会读取或写入哪些内容。

Read Code收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于技能本身和所用的模型或客户端,正式使用前按作者说明确认。

Read Code用什么许可证?

许可证标注为 未说明(许可证不明确)。商用或二次分发前请到仓库确认条款原文。

热门专题

按场景挑技能
全部专题 →

技能内容以作者仓库为准;分类、权限级别与许可证状态的中文说明为中文整理,最近核验 未标注。