diff --git a/README.es-ES.md b/README.es-ES.md new file mode 100644 index 0000000..e320c4d --- /dev/null +++ b/README.es-ES.md @@ -0,0 +1,286 @@ +

Understand Anything

+

+ Convierte cualquier código fuente, base de conocimiento o documentación en un grafo de conocimiento interactivo que puedes explorar, buscar y consultar. +
+ Compatible con Claude Code, Codex, Cursor, Copilot, Gemini CLI y más. +

+ +

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

+ +

+ + + + + Star History Rank + + +

+ +

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

+ +

+ Understand Anything — Convierte cualquier código fuente en un grafo de conocimiento interactivo +

+ +--- + +> [!TIP] +> **¡Un enorme agradecimiento a la comunidad!** El apoyo a Understand-Anything ha sido increíble. Si esta herramienta te ahorra unos minutos de buscar entre la complejidad, eso es todo lo que quería. 🚀 + +**Acabas de unirte a un nuevo equipo. El código tiene 200,000 líneas. ¿Por dónde empiezas?** + +Understand Anything es un plugin de [Claude Code](https://docs.anthropic.com/en/docs/claude-code) que analiza tu proyecto con un pipeline multi-agente, construye un grafo de conocimiento de cada archivo, función, clase y dependencia, y luego te ofrece un panel interactivo para explorarlo visualmente. Deja de leer código a ciegas. Empieza a ver el panorama completo. + +--- + +## ✨ Características + +### Explora el grafo estructural + +Navega tu código como un grafo de conocimiento interactivo: cada archivo, función y clase es un nodo que puedes hacer clic, buscar y explorar. Selecciona cualquier nodo para ver resúmenes en lenguaje natural, relaciones y recorridos guiados. + +

+ Grafo estructural — explora archivos, funciones, clases y sus relaciones +

+ +### Comprende la lógica de negocio + +Cambia a la vista de dominio y observa cómo tu código se mapea a procesos de negocio reales: dominios, flujos y pasos representados como un grafo horizontal. + +

+ Grafo de dominio — dominios de negocio, flujos y pasos de proceso +

+ +### Analiza bases de conocimiento + +Apunta `/understand-knowledge` a un [wiki LLM con patrón Karpathy](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f) y obtén un grafo de conocimiento dirigido por fuerzas con agrupación por comunidad. El parser determinístico extrae wikilinks y categorías de `index.md`, luego los agentes LLM descubren relaciones implícitas, extraen entidades y revelan afirmaciones, convirtiendo tu wiki en un grafo navegable de ideas interconectadas. + + + + + + + + + + + + + + +
+

🧭 Recorridos Guiados

+

Recorridos generados automáticamente de la arquitectura, ordenados por dependencia. Aprende el código en el orden correcto.

+
+

🔍 Búsqueda Difusa y Semántica

+

Encuentra cualquier cosa por nombre o por significado. Busca "¿qué partes manejan la autenticación?" y obtén resultados relevantes en todo el grafo.

+
+

📊 Análisis de Impacto de Cambios

+

Visualiza qué partes del sistema afectan tus cambios antes de hacer commit. Comprende los efectos en cascada a través del código.

+
+

🎭 Interfaz Adaptativa por Persona

+

El panel ajusta su nivel de detalle según quién eres: desarrollador junior, PM o usuario avanzado.

+
+

🏗️ Visualización por Capas

+

Agrupación automática por capa arquitectónica — API, Servicio, Datos, UI, Utilidades — con leyenda codificada por colores.

+
+

📚 Conceptos del Lenguaje

+

12 patrones de programación (genéricos, closures, decoradores, etc.) explicados en contexto donde aparecen.

+
+ +--- + +## 🚀 Inicio Rápido + +### 1. Instala el plugin + +```bash +/plugin marketplace add Lum1104/Understand-Anything +/plugin install understand-anything +``` + +### 2. Analiza tu código + +```bash +/understand +``` + +Un pipeline multi-agente escanea tu proyecto, extrae cada archivo, función, clase y dependencia, y construye un grafo de conocimiento guardado en `.understand-anything/knowledge-graph.json`. + +### 3. Explora el panel + +```bash +/understand-dashboard +``` + +Se abre un panel web interactivo con tu código visualizado como un grafo, codificado por colores según la capa arquitectónica, con funciones de búsqueda y clic. Selecciona cualquier nodo para ver su código, relaciones y una explicación en lenguaje natural. + +### 4. Sigue aprendiendo + +```bash +# Pregunta cualquier cosa sobre el código +/understand-chat How does the payment flow work? + +# Analiza el impacto de tus cambios actuales +/understand-diff + +# Profundiza en un archivo o función específica +/understand-explain src/auth/login.ts + +# Genera una guía de incorporación para nuevos miembros del equipo +/understand-onboard + +# Extrae conocimiento de dominio de negocio (dominios, flujos, pasos) +/understand-domain + +# Analiza un wiki LLM con patrón Karpathy +/understand-knowledge ~/path/to/wiki +``` + +--- + +## 🌐 Instalación Multiplataforma + +Understand-Anything funciona en múltiples plataformas de codificación con IA. + +### Claude Code (Nativo) + +```bash +/plugin marketplace add Lum1104/Understand-Anything +/plugin install understand-anything +``` + +### Codex + +Dile a Codex: +``` +Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.codex/INSTALL.md +``` + +### OpenCode + +Dile a OpenCode: +``` +Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.opencode/INSTALL.md +``` + +### OpenClaw + +Dile a OpenClaw: +``` +Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.openclaw/INSTALL.md +``` + +### Cursor + +Cursor detecta automáticamente el plugin a través de `.cursor-plugin/plugin.json` cuando se clona este repositorio. No requiere instalación manual: simplemente clona y abre en Cursor. + +### VS Code + GitHub Copilot + +VS Code con GitHub Copilot (v1.108+) detecta automáticamente el plugin a través de `.copilot-plugin/plugin.json` cuando se clona este repositorio. No requiere instalación manual: simplemente clona y abre en VS Code. + +Para habilidades personales (disponibles en todos los proyectos), dile a GitHub Copilot: +```text +Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.vscode/INSTALL.md +``` + +### Antigravity + +Dile a Antigravity: +```text +Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.antigravity/INSTALL.md +``` + +### Gemini CLI + +Dile a Gemini CLI: +```text +Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.gemini/INSTALL.md +``` + +### Pi Agent + +Dile a Pi Agent: +```text +Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.pi/INSTALL.md +``` + +### Compatibilidad de Plataformas + +| Plataforma | Estado | Método de Instalación | +|----------|--------|----------------| +| Claude Code | ✅ Nativo | Marketplace de plugins | +| Codex | ✅ Soportado | Instalación guiada por IA | +| OpenCode | ✅ Soportado | Instalación guiada por IA | +| OpenClaw | ✅ Soportado | Instalación guiada por IA | +| Cursor | ✅ Soportado | Detección automática | +| VS Code + GitHub Copilot | ✅ Soportado | Detección automática | +| Antigravity | ✅ Soportado | Instalación guiada por IA | +| Gemini CLI | ✅ Soportado | Instalación guiada por IA | +| Pi Agent | ✅ Soportado | Instalación guiada por IA | + +--- + +## 🔧 Bajo el Capó + +### Pipeline Multi-Agente + +El comando `/understand` orquesta 5 agentes especializados, y `/understand-domain` añade un sexto: + +| Agente | Rol | +|-------|------| +| `project-scanner` | Descubre archivos, detecta lenguajes y frameworks | +| `file-analyzer` | Extrae funciones, clases e importaciones; produce nodos y aristas del grafo | +| `architecture-analyzer` | Identifica capas arquitectónicas | +| `tour-builder` | Genera recorridos de aprendizaje guiados | +| `graph-reviewer` | Valida la completitud y la integridad referencial del grafo (se ejecuta inline por defecto; usa `--review` para una revisión completa con LLM) | +| `domain-analyzer` | Extrae dominios de negocio, flujos y pasos de proceso (usado por `/understand-domain`) | +| `article-analyzer` | Extrae entidades, afirmaciones y relaciones implícitas de artículos wiki (usado por `/understand-knowledge`) | + +Los analizadores de archivos se ejecutan en paralelo (hasta 5 concurrentes, 20-30 archivos por lote). Soporta actualizaciones incrementales: solo reanaliza los archivos que cambiaron desde la última ejecución. + +--- + +## 🤝 Contribuir + +¡Las contribuciones son bienvenidas! Así puedes empezar: + +1. Haz fork del repositorio +2. Crea una rama de funcionalidad (`git checkout -b feature/my-feature`) +3. Ejecuta las pruebas (`pnpm --filter @understand-anything/core test`) +4. Haz commit de tus cambios y abre un pull request + +Para cambios importantes, abre primero un issue para que podamos discutir el enfoque. + +--- + +

+ Deja de leer código a ciegas. Empieza a entenderlo todo. +

+ +## Historial de Stars + + + + + + Star History Chart + + + +

+ Licencia MIT © Lum1104 +

diff --git a/README.ja-JP.md b/README.ja-JP.md index 1eb0c48..4b1f5bd 100644 --- a/README.ja-JP.md +++ b/README.ja-JP.md @@ -7,7 +7,7 @@

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

diff --git a/README.ko-KR.md b/README.ko-KR.md new file mode 100644 index 0000000..7bac616 --- /dev/null +++ b/README.ko-KR.md @@ -0,0 +1,286 @@ +

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 + Gemini CLI + OpenCode + Homepage + Live Demo +

+ +

+ Understand Anything — 모든 코드베이스를 인터랙티브 지식 그래프로 변환 +

+ +--- + +> [!TIP] +> **커뮤니티의 엄청난 응원에 감사드립니다!** Understand-Anything에 대한 관심이 정말 놀라웠습니다. 이 도구가 복잡한 코드를 파악하는 시간을 단 몇 분이라도 줄여드린다면, 그것만으로도 충분합니다. 🚀 + +**새 팀에 합류했습니다. 코드베이스가 20만 줄입니다. 어디서부터 시작하시겠습니까?** + +Understand Anything은 [Claude Code](https://docs.anthropic.com/en/docs/claude-code) 플러그인으로, 멀티 에이전트 파이프라인을 통해 프로젝트를 분석하고, 모든 파일, 함수, 클래스, 의존성에 대한 지식 그래프를 구축한 뒤, 이를 시각적으로 탐색할 수 있는 인터랙티브 대시보드를 제공합니다. 더 이상 코드를 맹목적으로 읽지 마세요. 전체 그림을 파악하세요. + +--- + +## ✨ 주요 기능 + +### 구조 그래프 탐색 + +코드베이스를 인터랙티브 지식 그래프로 탐색하세요. 모든 파일, 함수, 클래스가 클릭, 검색, 탐색 가능한 노드입니다. 노드를 선택하면 이해하기 쉬운 요약, 관계, 가이드 투어를 확인할 수 있습니다. + +

+ 구조 그래프 — 파일, 함수, 클래스 및 관계 탐색 +

+ +### 비즈니스 로직 이해 + +도메인 뷰로 전환하면 코드가 실제 비즈니스 프로세스에 어떻게 매핑되는지 확인할 수 있습니다. 도메인, 흐름, 단계가 수평 그래프로 표시됩니다. + +

+ 도메인 그래프 — 비즈니스 도메인, 흐름 및 프로세스 단계 +

+ +### 지식 베이스 분석 + +`/understand-knowledge`를 [Karpathy 패턴 LLM 위키](https://gist.github.com/karpathy/442a6bf555914893e9891c11519de94f)에 연결하면 커뮤니티 클러스터링이 적용된 힘 기반 지식 그래프를 생성합니다. 결정론적 파서가 `index.md`에서 위키링크와 카테고리를 추출한 후, LLM 에이전트가 암묵적 관계를 발견하고, 엔티티를 추출하며, 주장을 도출하여 위키를 탐색 가능한 상호 연결된 아이디어 그래프로 변환합니다. + + + + + + + + + + + + + + +
+

🧭 가이드 투어

+

의존성 순서에 따라 자동 생성되는 아키텍처 워크스루입니다. 올바른 순서로 코드베이스를 학습하세요.

+
+

🔍 퍼지 및 시맨틱 검색

+

이름 또는 의미로 무엇이든 검색하세요. "인증을 처리하는 부분은?" 같은 질문으로 그래프 전체에서 관련 결과를 얻을 수 있습니다.

+
+

📊 변경 영향 분석

+

커밋 전에 변경 사항이 시스템의 어떤 부분에 영향을 미치는지 확인하세요. 코드베이스 전반의 파급 효과를 이해하세요.

+
+

🎭 페르소나 적응형 UI

+

사용자 유형(주니어 개발자, PM, 파워 유저)에 따라 대시보드의 상세 수준이 자동으로 조정됩니다.

+
+

🏗️ 레이어 시각화

+

아키텍처 레이어별 자동 그룹화 — API, 서비스, 데이터, UI, 유틸리티 — 색상 코드 범례가 함께 제공됩니다.

+
+

📚 프로그래밍 개념

+

12가지 프로그래밍 패턴(제네릭, 클로저, 데코레이터 등)이 코드에 등장하는 맥락에서 설명됩니다.

+
+ +--- + +## 🚀 빠른 시작 + +### 1. 플러그인 설치 + +```bash +/plugin marketplace add Lum1104/Understand-Anything +/plugin install understand-anything +``` + +### 2. 코드베이스 분석 + +```bash +/understand +``` + +멀티 에이전트 파이프라인이 프로젝트를 스캔하고, 모든 파일, 함수, 클래스, 의존성을 추출한 뒤, `.understand-anything/knowledge-graph.json`에 지식 그래프를 저장합니다. + +### 3. 대시보드 탐색 + +```bash +/understand-dashboard +``` + +코드베이스가 그래프로 시각화된 인터랙티브 웹 대시보드가 열립니다. 아키텍처 레이어별로 색상이 구분되어 있으며, 검색과 클릭이 가능합니다. 노드를 선택하면 코드, 관계, 이해하기 쉬운 설명을 확인할 수 있습니다. + +### 4. 더 깊이 탐구하기 + +```bash +# 코드베이스에 대해 무엇이든 질문하기 +/understand-chat How does the payment flow work? + +# 현재 변경 사항의 영향 분석 +/understand-diff + +# 특정 파일이나 함수를 심층 분석 +/understand-explain src/auth/login.ts + +# 새 팀원을 위한 온보딩 가이드 생성 +/understand-onboard + +# 비즈니스 도메인 지식 추출 (도메인, 흐름, 단계) +/understand-domain + +# Karpathy 패턴 LLM 위키 지식 베이스 분석 +/understand-knowledge ~/path/to/wiki +``` + +--- + +## 🌐 멀티 플랫폼 설치 + +Understand-Anything은 다양한 AI 코딩 플랫폼에서 사용할 수 있습니다. + +### Claude Code (네이티브) + +```bash +/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에 입력하세요: +```text +Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.vscode/INSTALL.md +``` + +### Antigravity + +Antigravity에 입력하세요: +```text +Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.antigravity/INSTALL.md +``` + +### Gemini CLI + +Gemini CLI에 입력하세요: +```text +Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.gemini/INSTALL.md +``` + +### Pi Agent + +Pi Agent에 입력하세요: +```text +Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.pi/INSTALL.md +``` + +### 플랫폼 호환성 + +| 플랫폼 | 상태 | 설치 방법 | +|----------|--------|----------------| +| Claude Code | ✅ 네이티브 | 플러그인 마켓플레이스 | +| Codex | ✅ 지원 | AI 기반 설치 | +| OpenCode | ✅ 지원 | AI 기반 설치 | +| OpenClaw | ✅ 지원 | AI 기반 설치 | +| Cursor | ✅ 지원 | 자동 인식 | +| VS Code + GitHub Copilot | ✅ 지원 | 자동 인식 | +| Antigravity | ✅ 지원 | AI 기반 설치 | +| Gemini CLI | ✅ 지원 | AI 기반 설치 | +| Pi Agent | ✅ 지원 | AI 기반 설치 | + +--- + +## 🔧 작동 원리 + +### 멀티 에이전트 파이프라인 + +`/understand` 명령은 5개의 전문 에이전트를 조율하며, `/understand-domain`은 6번째 에이전트를 추가합니다: + +| 에이전트 | 역할 | +|-------|------| +| `project-scanner` | 파일 탐색, 언어 및 프레임워크 감지 | +| `file-analyzer` | 함수, 클래스, 임포트 추출; 그래프 노드 및 엣지 생성 | +| `architecture-analyzer` | 아키텍처 레이어 식별 | +| `tour-builder` | 가이드 학습 투어 생성 | +| `graph-reviewer` | 그래프 완전성 및 참조 무결성 검증 (기본적으로 인라인 실행; 전체 LLM 검토는 `--review` 사용) | +| `domain-analyzer` | 비즈니스 도메인, 흐름 및 프로세스 단계 추출 (`/understand-domain`에서 사용) | +| `article-analyzer` | 위키 문서에서 엔티티, 주장 및 암묵적 관계 추출 (`/understand-knowledge`에서 사용) | + +파일 분석기는 병렬로 실행됩니다(최대 5개 동시, 배치당 20~30개 파일). 증분 업데이트를 지원하여 마지막 실행 이후 변경된 파일만 재분석합니다. + +--- + +## 🤝 기여하기 + +기여를 환영합니다! 시작하는 방법은 다음과 같습니다: + +1. 저장소를 Fork합니다 +2. 기능 브랜치를 생성합니다 (`git checkout -b feature/my-feature`) +3. 테스트를 실행합니다 (`pnpm --filter @understand-anything/core test`) +4. 변경 사항을 커밋하고 Pull Request를 생성합니다 + +주요 변경 사항의 경우, 먼저 Issue를 열어 접근 방식을 논의해 주세요. + +--- + +

+ 더 이상 코드를 맹목적으로 읽지 마세요. 모든 것을 이해하세요. +

+ +## Star 히스토리 + + + + + + Star History Chart + + + +

+ MIT 라이선스 © Lum1104 +

diff --git a/README.md b/README.md index 6ce8da7..72e5820 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@

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

diff --git a/README.tr-TR.md b/README.tr-TR.md index 73da194..17d6e07 100644 --- a/README.tr-TR.md +++ b/README.tr-TR.md @@ -7,7 +7,7 @@

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

diff --git a/README.zh-CN.md b/README.zh-CN.md index 8bc4f57..7b6946a 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -6,7 +6,7 @@

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

diff --git a/README.zh-TW.md b/README.zh-TW.md index e2c17cc..f4a0aba 100644 --- a/README.zh-TW.md +++ b/README.zh-TW.md @@ -6,7 +6,7 @@

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