Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

X-ray

一个用于快速扫描、理解并可视化陌生代码项目的 Skill。

X-ray 能做什么?

调用 X-ray 后,它会扫描当前项目,并帮助你快速了解:

  • 这个项目是做什么的
  • 使用了哪些技术栈
  • 项目的文件与目录结构
  • 整体架构
  • 项目复杂度
  • 哪些文件值得优先阅读
  • 适合哪些方向的人学习
  • 推荐的代码阅读顺序

最终生成一个 HTML 可视化项目分析报告。

工作原理

X-ray 的工作流程:

  1. 扫描项目并收集一手数据
  2. 生成 xray-data.json
  3. 根据分析规则理解扫描结果
  4. 阅读 README、配置文件和关键源码
  5. 分析项目类型、技术栈、架构和复杂度
  6. 生成 HTML 可视化报告

简单来说:

脚本负责获取事实,AI 负责理解项目,HTML 负责展示结果。

目录结构

x-ray/
├── assets/
│   └── report-template.html
├── references/
│   └── analysis-rules.md
├── scripts/
│   ├── complexity.py
│   ├── detect_stack.py
│   ├── find_key_files.py
│   ├── render_report.py
│   ├── run_xray.py
│   └── scan_repo.py
└── SKILL.md

About

一个用于快速扫描、理解并可视化陌生代码项目的 Skill

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages