Skip to content

Readme.skill

Turn your local Claude Code / Codex CLI history into a shareable, anonymized AI-Native developer profile + viral SVG poster. A skill, not a script — 100% local & read-only.

Install

$/plugin marketplace add study8677/Readme.skill

Install command taken from the project's README or registry entry. Always review code before running it.

Readme.skill

30 秒,把你和 AI 协作的一切,变成一张能发朋友圈的开发者名片。

读取本地 Claude Code / Codex CLI / Kiro / Trae / Gemini Antigravity / Cursor 的真实使用数据,自动生成对外可分享、默认脱敏的 AI-Native 开发者画像 —— 一份长报告 + 一张竖屏海报。

🌐 中文 · English | 📥 安装 · 🎬 看效果 · ❓ FAQ · 🗺️ Roadmap


↑ v2.5.1 在作者电脑上跑出的最新真实输出(148 天 · 22.21B token · 23.8× cache leverage · 2,217★ · 4 个 AI 工具并用)。 点击图片查看完整 中文 Markdown profile · English profile。


✨ 它能给你什么

  • 一份长报告(示例)— 10 个维度叙事:AI-native 实践 / Cache leverage / Session 架构 / Token 经济学 / Evolution 曲线 / 项目领域 …
  • 月度 / 阶段报告 — 可以指定 2026-05、2026-03 到 2026-05、最近30天,看某个阶段 AI 编码带来的效果和变化。
  • 一张竖屏海报(示例 SVG)— 1080×1920,6 个英雄数字 + AI 自评金句 + 身份徽章 + 一键安装 CTA,社媒直发不丢人。
  • 完全本地完成:除调用 gh 拉你自己的 GitHub 公开贡献外,0 联网、0 上传、0 写盘到 ~/.claude。
  • 默认匿名:项目名变 「项目 A/B/C」,私有仓变 Private Repo X,API key / token / 邮箱按 OWASP 正则清洗。
  • 一句话触发:装好后只要说「生成我的 AI 档案」,AI 自动跑完 9 个 Step。

🎯 谁会想用

你是 你能用它做什么
正在求职的开发者 在 GitHub profile 顶部放一张你跟 AI 协作的真实画像,比简历的 "熟练使用 AI 工具" 强 100 倍
AI-Native 实践派 量化展示你的 cache leverage、多模型编排、自建 skill 数 —— 这些数字用面试讲不出来
年终复盘 / 月报 / 周报困难户 跑一次,得到全量或指定月份的活跃热力图 + Evolution 曲线,复盘材料一键齐
小红书 / 推特 / 微信 创作者 海报内置传播 3 件套(金句 + 徽章 + 安装 CTA),转发链路天然形成
团队 Tech Lead 让团队每人跑一份,了解大家的 AI 协作深度,找 best practice 而不是 best worker

⚡ 30 秒装上

方式零:Claude Code Plugin(推荐 —— 两行命令)

在 Claude Code 里:

/plugin marketplace add study8677/Readme.skill
/plugin install readme-skill@study8677

Claude Code 自动发现 skills/readme-skill/SKILL.md 并挂载,无需手动 symlink。

方式一:Clone + 软链(Codex CLI 或不想用 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

方式二、方式三(直接复制 / curl 一行装)

# 方式二:直接复制
git clone https://github.com/study8677/Readme.skill.git
mkdir -p ~/.claude/skills/readme-skill
cp Readme.skill/skills/readme-skill/SKILL.md ~/.claude/skills/readme-skill/
# Codex 同理:mkdir -p ~/.codex/skills/readme-skill && cp ... ~/.codex/skills/readme-skill/

# 方式三:一行 curl
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: 把 ~/.claude 替换为 ~/.codex

🎬 怎么用

安装后在 Claude Code 或 Codex 的对话里说出以下任一句即可触发:

  • 「生成我的 AI 档案」
  • 「做一份 AI-native README」
  • 「分析我的 Claude / Codex 使用情况」
  • 「生成 2026-05 的 AI 月度报告」
  • 「分析 2026-03 到 2026-05 AI 编码变化」
  • "build my AI usage profile"
  • "build my AI usage profile for May 2026"
  • "summarize my Claude / Codex history"

AI 会跑完整套流程,把结果写到 output/profile_<日期>.md + output/poster_<日期>_<lang>.svg,并在结束前校验 SVG 能被浏览器正常解析。除非你明确说「不要海报 / 只要 markdown」,否则默认会生成海报。如果指定月份 / 时间范围,文件名会带上窗口后缀,例如 output/profile_202605_<日期>.md 和 output/poster_202605_<日期>_<lang>.svg。中文提问出中文版,英文提问出英文版。

私人版 vs 分享版

  • 默认(分享版) — 项目名匿名为「项目 A/B/C」,私有仓库改为「Private Repo X」。
  • 私人版 — 加一句「私人版 / 不要脱敏 / show real names」,AI 会保留真实名字(仍会脱敏 API key、邮箱)。

🌐 支持的 AI 编程工具

Similar plugs

The 1st Collaborative AI Design Agent Workspace. Local-first and open source. Create prototypes, websites, apps, dashboards, presentations, images, and videos with your team…

Open-source AI job search agent and job finder: scan job boards, score each job 1-5 against your CV before you apply, tailor an ATS-friendly resume and cover letter, get…