Skip to content

README.zh-CN.md

Latest commit

 

History

History
324 lines (235 loc) · 12.2 KB

README.zh-CN.md

File metadata and controls

324 lines (235 loc) · 12.2 KB

Understand Anything

将任意代码库、知识库或文档转化为可探索、可搜索、可对话的交互式知识图谱
支持 Claude Code、Codex、Cursor、Copilot、Gemini CLI 等多平台。

English | 简体中文 | 繁體中文 | 日本語 | 한국어 | Español | Türkçe

Star History Rank

Quick Start License: MIT Claude Code Codex Copilot Copilot CLI Gemini CLI OpenCode Homepage Live Demo

Understand Anything — 将任何代码库转换为交互式知识图谱

Tip

衷心感谢社区的支持！ Understand-Anything 收到的关注超出了我的预期。如果这个工具能帮你从复杂的资料中理出一点头绪，少走几分钟弯路，那我开发它的初衷就达到了。🚀

当你刚加入一个新团队，面对 20 万行代码，你从哪里开始？

Understand Anything 是一个基于 Claude Code 的插件，通过多智能体（multi-agent）架构分析你的项目，构建包含文件、函数、类以及依赖关系的知识图谱，并提供一个可视化交互界面，帮助你理解整个系统。不再”盲读代码”，而是从全局视角理解系统结构。

寓教于乐的图表 > 仅为炫技的图表。

✨ 核心功能

Note

想直接体验？ 在我们的主页试试在线演示 — 一个可以平移、缩放、搜索和探索的全交互式仪表盘。

探索代码结构图

将你的代码库以交互式知识图谱的形式呈现——每个文件、函数和类都是可点击、可搜索、可探索的节点。选择任意节点即可查看通俗易懂的摘要、依赖关系和引导式学习路径。

结构图——探索文件、函数、类及其关系

理解业务逻辑

切换到领域视图，查看代码如何映射到真实的业务流程——以水平图的形式展示领域、流程和步骤。

领域图——业务领域、流程和处理步骤

分析知识库

将 /understand-knowledge 指向一个 Karpathy 模式的 LLM Wiki，即可获得带有社区聚类的力导向知识图谱。确定性解析器从 index.md 中提取 wikilinks 和分类，然后 LLM 代理发现隐式关系、提取实体并挖掘论断——将你的 wiki 转化为可导航的互联思想图谱。

🧭 引导式学习

自动生成架构学习路径，按依赖顺序学习。

🔍 语义搜索

支持模糊搜索 + 语义搜索，例如搜索"哪些部分处理身份验证？"即可在整个图中获取相关结果。

📊 变更影响分析

提交更改前，查看更改会影响系统的哪些部分。了解更改对整个代码库的连锁反应。

🎭 用户角色自适应 UI

根据用户类型（初级开发 / 项目经理 / 高级用户）调整其详细程度。

🏗️ 层级可视化

按架构层级自动分组 — API，服务，数据，UI, 系统工具 — 并附有颜色编码图例。

📚 语言概念

12 种编程模式（泛型、闭包、装饰器等）将在上下文中逐一解释。

🚀 快速开始

1. 安装插件

/plugin marketplace add Lum1104/Understand-Anything
/plugin install understand-anything

2. 分析你的代码库

/understand

多智能体（multi-agent）架构会：扫描你的项目，提取函数 / 类 / 依赖，构建知识图谱保存至.understand-anything/knowledge-graph.json.

3. 打开数据看板

/understand-dashboard

打开交互式网页数据看板，您的代码库将以图表形式呈现 — 按架构层级进行颜色编码，支持搜索和点击。选择任意节点即可查看其代码、关系以及简明易懂的解释。

4. 深度使用

# 询问任意代码库的问题
/understand-chat How does the payment flow work?

# 分析当前修改的影响
/understand-diff

# 深入理解某个文件
/understand-explain src/auth/login.ts

# 为新团队成员生成指南
/understand-onboard

# 提取业务领域知识（领域、流程、步骤）
/understand-domain

# 分析 Karpathy 模式的 LLM Wiki 知识库
/understand-knowledge ~/path/to/wiki

🌐 多平台支持

Understand-Anything 可在多个 AI 编码平台上运行。

Claude Code （原生支持）

/plugin marketplace add Lum1104/Understand-Anything
/plugin install understand-anything

Codex

告诉 Codex:

Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.codex/INSTALL.md

OpenCode

告诉 OpenCode:

Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.opencode/INSTALL.md

OpenClaw

告诉 OpenClaw:

Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.openclaw/INSTALL.md

Cursor

克隆此仓库后，Cursor 会自动通过 .cursor-plugin/plugin.json文件发现插件。无需手动安装 — 只需克隆并在 Cursor 中打开即可。

VS Code + GitHub Copilot

安装 GitHub Copilot 扩展（v1.108+）后，VS Code 会通过 .copilot-plugin/plugin.json 自动发现插件，克隆后直接在 VS Code 中打开即可，无需手动安装。

若需要在所有项目中使用（个人技能），告诉 GitHub Copilot：

Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.vscode/INSTALL.md

Copilot CLI

copilot plugin install Lum1104/Understand-Anything:understand-anything-plugin

Antigravity

告诉 Antigravity:

Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.antigravity/INSTALL.md

Gemini CLI

告诉 Gemini CLI:

Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.gemini/INSTALL.md

Pi Agent

告诉 Pi Agent:

Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.pi/INSTALL.md

多平台兼容

平台 状态 安装方式
Claude Code ✅ Native 插件市场
Codex ✅ 支持 AI驱动安装
OpenCode ✅ 支持 AI驱动安装
OpenClaw ✅ 支持 AI驱动安装
Cursor ✅ 支持 自动发现
VS Code + GitHub Copilot ✅ 支持 自动发现
Copilot CLI ✅ 支持 插件安装
Antigravity ✅ 支持 AI驱动安装
Gemini CLI ✅ 支持 AI驱动安装
Pi Agent ✅ 支持 AI驱动安装

📦 与团队共享知识图谱

图谱就是一份 JSON 文件——提交一次，团队成员就可以跳过整条流水线。适合新人上手、PR 评审和 docs-as-code 工作流。

示例： GoogleCloudPlatform/microservices-demo（fork） —— 包含已提交图谱的 Go / Java / Python / Node 多语言参考项目。

需要提交的内容： .understand-anything/ 下的全部文件，除了 intermediate/ 和 diff-overlay.json（这些是本地临时文件）。

.understand-anything/intermediate/
.understand-anything/diff-overlay.json

保持最新： 启用 /understand --auto-update —— 一个 post-commit 钩子会增量更新图谱，每次提交都能得到匹配的图谱版本。也可以在发布前手动重跑 /understand。

大型图谱（10 MB 以上）： 使用 git-lfs 跟踪。

git lfs install
git lfs track ".understand-anything/*.json"
git add .gitattributes .understand-anything/

🔧 技术原理

多智能体架构

/understand 命令调用 5 个 agent，/understand-domain 额外增加第 6 个：

Agent 职责
project-scanner 扫描项目文件，检测语言和框架
file-analyzer 提取代码结构（函数、类和导入），生成图节点和边
architecture-analyzer 识别架构层
tour-builder 生成引导式学习路径
graph-reviewer 验证图的完整性和引用完整性
domain-analyzer 提取业务领域、流程和处理步骤（由 /understand-domain 使用）
article-analyzer 从 wiki 文章中提取实体、论断和隐式关系（由 /understand-knowledge 使用）

文件分析器并行运行（最多 3 个并发）。支持增量更新 — 仅重新分析自上次运行以来发生更改的文件。

🤝 贡献

欢迎贡献！以下是贡献指南：

  1. Fork 项目
  2. 新建分支 (git checkout -b feature/my-feature)
  3. 运行测试 (pnpm --filter @understand-anything/core test)
  4. 提交更改并创建一个PR请求

对于重大变更，请先提交 issue，以便我们讨论解决方案。

不再盲读代码，而是理解整个系统

Star 历史记录

Star History Chart

MIT 许可证 © Lum1104