by study8677
一份 Claude Code / Codex CLI 的 skill:自动生成对外可分享、脱敏的 AI-Native 开发者 README。
# Add to your Claude Code skills
git clone https://github.com/study8677/Readme.skillGuides for using cli tools skills like Readme.skill.
一份 Claude Code / Codex CLI 的 skill:自动生成对外可分享、脱敏的 AI-Native 开发者 README。
🌐 中文 (you are here) · English README
🎉 2026-05-08 入选:本项目登上 阮一峰《科技爱好者周刊》第 395 期「AI 相关」板块——感谢阮老师推荐!🙏
Readme.skill 不是一个程序,而是一份给 AI agent 的指令集(即 SKILL.md)。当你在 Claude Code 或 Codex 里说出触发词(如「生成我的 AI 档案」),AI 会按照 SKILL.md 的步骤:
~/.claude/、项目内 .claude/plans(如配置)与 ~/.codex/ 的统计文件、SQLite、历史 JSONLgh 拉取你的 GitHub 公开贡献日历与 top 仓库git log,统计本地提交output/profile_YYYYMMDD.md 或 output/profile_YYYYMMDD_en.md整个过程只读、不联网(除 gh),可放心运行并对外分享结果。对话正文可被读取以提取关键词和协作风格信号,但原文不会写进报告。
在 Claude Code 里:
/plugin marketplace add study8677/Readme.skill
/plugin install readme-skill@study8677
Claude Code 自动发现 skills/readme-skill/SKILL.md 并挂载,无需手动 symlink。需要 Claude Code 支持 plugin 子系统的版本。
git clone https://github.com/study8677/Readme.skill.git
cd Readme.skill
# Claude Code 用户
mkdir -p ~/.claude/skills/readme-skill
ln -sf "$(pwd)/skills/readme-skill/SKILL.md" ~/.claude/skills/readme-skill/SKILL.md
# Codex CLI 用户
mkdir -p ~/.codex/skills/readme-skill
ln -sf "$(pwd)/skills/readme-skill/SKILL.md" ~/.codex/skills/readme-skill/SKILL.md
No comments yet. Be the first to share your thoughts!
Top skills in this category by stars
git clone https://github.com/study8677/Readme.skill.git
# Claude Code
mkdir -p ~/.claude/skills/readme-skill
cp Readme.skill/skills/readme-skill/SKILL.md ~/.claude/skills/readme-skill/
# Codex CLI
mkdir -p ~/.codex/skills/readme-skill
cp Readme.skill/skills/readme-skill/SKILL.md ~/.codex/skills/readme-skill/
# Claude Code
mkdir -p ~/.claude/skills/readme-skill && curl -fsSL https://raw.githubusercontent.com/study8677/Readme.skill/main/skills/readme-skill/SKILL.md -o ~/.claude/skills/readme-skill/SKILL.md
# Codex CLI
mkdir -p ~/.codex/skills/readme-skill && curl -fsSL https://raw.githubusercontent.com/study8677/Readme.skill/main/skills/readme-skill/SKILL.md -o ~/.codex/skills/readme-skill/SKILL.md
安装后在 Claude Code 或 Codex 的对话里说出以下任一句即可触发:
AI 会跑完整套流程,把结果写到 output/profile_<日期>.md。如果你用英文提问或明确要求英文版,会写到 output/profile_<日期>_en.md。
两份产物:
examples/example_profile.mdSVG 是源图,要发微信 / 小红书 / Twitter / Instagram 通常需要 PNG:
# 方式 1: rsvg-convert (需要 brew install librsvg)
rsvg-convert -h 1920 output/poster_*.svg > poster.png
# 方式 2: 用 Chrome / 浏览器
open output/poster_*.svg # macOS 默认打开 → 右键另存为 PNG / 截图
# 方式 3: chromium headless
chromium --headless --screenshot=poster.png --window-size=1080,1920 output/poster_*.svg
设计原则(来自 v2.4 brief):3 秒看懂身份 + 6 个证据数字 · 避免 emoji(跨平台字体替换问题)· system-ui 字体 fallback · 数字必须有证据缺则降级。
| 来源 | 路径 | 用途 |
| --- | --- | --- |
| Claude Code 预聚合 | ~/.claude/stats-cache.json | sessions / messages / tokens / hour heatmap |
| Claude 命令历史 | ~/.claude/history.jsonl | slash 命令热度、项目归属 |
| Claude 项目 | ~/.claude/projects/<encoded>/*.jsonl | 每项目 session 计数 + 真实 cwd 还原 |
| Claude 计划 | ~/.claude/plans/*.md + settings 中的 plansDirectory | plan 数量与标题(关键词语料) |
| Claude skills | ~/.claude/skills/ | 自研 skill 数 |
| Codex 主库 | ~/.codex/state_5.sqlite (read-only) | threads 表的全部统计 |
| Codex 命令 | ~/.codex/history.jsonl | prompt 文本采样 |
| GitHub | gh api graphql | 365 天 contributions、top repos、语言 |
| 本地 Git | 候选目录的 git log | commits / additions / deletions |
缺少某个数据源?没关系。Skill 内置降级策略:没有 Codex SQLite 就跳过 Codex 章节,没有
gh就跳过 GitHub 章节,报告照样生成。
gh 调用 GitHub 自身外不联网message.content)可被读取以增强关键词、协作风格、Session 架构分析,但原文不会写进报告~/.claude 或 ~/.codex 下任何文件(SQLite 用 mode=ro&immutable=1 打开)Skill = 给 AI agent 的指令集,不是替它做事的代码。
SKILL.md 是唯一的真实交付物。任何"为什么不用一个 Python 脚本一把跑完?"的冲动都被刻意抑制——目的是让 AI 自己理解数据、自己做权衡、自己写出有温度的文字,而不是机械地填模板。