360 Secure SkillHub
360 安全技能中心

Q-ray

Q-ray 用于快速理解陌生代码库:运行本地 Python 脚本扫描目录结构,读取扫描数据与分析规则,再结合 README、配置、入口和源码,判断项目类型、技术栈、文件结构、架构、复杂度、适合的学习方向与推荐阅读顺序,最终输出独立可打开的 HTML 可视化报告。默认只读,不修改源码、不安装依赖、不执行项目代码。

hongxiupiaoxiang
hongxiupiaoxiang
热度 7.64
最近更新 2026-09-23 09:50:48
分类:开发依赖:代码执行 / 读写文件 / 内部调用大模型应用场景:代码审查 / 报告撰写 / 研究

安装技能

复制下面的话术发给你的 Agent,它会通过 secure-skills 检索并安装该技能。

执行命令安装此 skill: npx secure-skills-cli add q-ray
Metadata
name
q-ray
description
扫描一个陌生的软件项目,快速识别项目类型、技术栈、架构、文件结构、复杂度和学习价值。适用于用户希望快速理解、探索、检查或接手一个陌生代码库的场景。

Q-ray

分析当前软件项目,并生成一份简洁、可视化的项目概览。

目标

调用 Q-ray 时:

  1. 扫描项目目录结构。
  2. 判断项目是什么类型。
  3. 识别主要技术栈。
  4. 找出重要目录和关键文件。
  5. 推断项目的整体架构。
  6. 评估项目复杂度。
  7. 判断这个项目适合哪些方向的人学习。
  8. 推荐理解项目的阅读顺序。
  9. 最终生成一个独立可打开的 HTML 可视化报告。

安全规则

默认把项目视为只读。

不要:

  • 修改项目源代码;
  • 安装依赖;
  • 执行项目代码;
  • 读取或暴露 .env 等文件中的敏感信息;
  • 执行未知脚本。

优先使用静态分析和文件读取来理解项目。

工作流程

当用户调用 Q-ray 分析一个陌生项目时:

  1. 使用 scripts/run_qray.py 扫描当前项目。
  2. 读取扫描生成的 qray-data.json。
  3. 读取 references/analysis-rules.md,按照其中的规则解释扫描数据。
  4. 根据 qray-data.json 中的文件列表,进一步读取:
    • README
    • 项目配置文件
    • 程序入口
    • 关键源码文件
  5. 基于真实扫描数据和实际源码,分析:
    • 这个项目是什么
    • 项目类型
    • 技术栈
    • 文件结构
    • 整体架构
    • 项目复杂度
    • 适合哪些方向的人学习
    • 推荐阅读顺序
  6. 最终生成一个 HTML 可视化项目报告。

原则

  • 优先依据 qray-data.json 和实际源码。
  • references 只提供分析方法,不提供项目事实。
  • 不确定的信息明确标记为“不确定”。
  • 不修改被分析项目的源代码。
  • 不安装依赖。
  • 不执行未知项目代码。