Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
node_modules
dist
.understand-anything
.ua
*.tsbuildinfo
.DS_Store
.env
Expand Down
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,10 +140,28 @@ A multi-agent pipeline scans your project, extracts every file, function, class,

On the **first run** in a project — when you don't pass `--language` and no language is stored yet — `/understand` detects the language you're conversing in. If it isn't English, it asks you to confirm (or override) before generating; English conversations are unaffected. Your choice is saved to `.ua/config.json` and reused on every later run.

**Project-level tree-sitter extension aliases:** If your codebase uses custom file extensions, add them to `.ua/config.json` (or the legacy `.understand-anything/config.json` if your project already uses that directory):

```json
{
"treeSitter": {
"extensionLanguageMap": {
".customts": "typescript",
".custompy": "python"
}
}
}
```

This lets `/understand` treat those extensions as the specified language during tree-sitter-based structural scanning.

The `--language` parameter affects:
- Node summaries and descriptions in the knowledge graph
- Dashboard UI labels, buttons, and tooltips
- Guided tour explanations
- `/understand-domain` output (domain, flow, step names/summaries)
- `/understand-onboard` generated onboarding guide text
- `/understand-knowledge` inferred entity/claim/edge descriptions

### 3. Explore the dashboard

Expand Down Expand Up @@ -171,6 +189,15 @@ An interactive web dashboard opens with your codebase visualized as a graph —
# Extract business domain knowledge (domains, flows, steps)
/understand-domain

# Extract domain knowledge in Chinese (also persisted to config.json)
/understand-domain --language zh

# Generate onboarding guide in Chinese
/understand-onboard --language zh

# Analyze Karpathy wiki and output inferred knowledge in Chinese
/understand-knowledge ~/path/to/wiki --language zh

# Analyze a Karpathy-pattern LLM wiki knowledge base
/understand-knowledge ~/path/to/wiki

Expand Down Expand Up @@ -213,7 +240,7 @@ curl -fsSL https://raw.githubusercontent.com/Egonex-AI/Understand-Anything/main/
iwr -useb https://raw.githubusercontent.com/Egonex-AI/Understand-Anything/main/install.ps1 | iex
```

The installer clones the repo to `~/.understand-anything/repo` and creates the right symlinks for the chosen platform. Restart your CLI/IDE afterwards.
The installer clones the repo to `~/.understand-anything/repo` and creates the right symlinks for the chosen platform. For platforms with a supported agent-profile directory, it also links the bundled `agents/*.md` profiles so the multi-agent pipeline can run without deterministic fallback. Restart your CLI/IDE afterwards.

> **Note on invoking skills:** the invocation prefix differs per platform. Most platforms use slash commands (`/understand`), but **Codex uses `$` instead** — type `$understand`, not `/understand`. If neither prefix is recognized on your platform, just ask in plain language: *"Use the understand skill to analyze this project."*

Expand Down
29 changes: 29 additions & 0 deletions READMEs/README.es-ES.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<em>Compatible con Claude Code, Codex, Cursor, Copilot, Gemini CLI y más.</em>
</p>

<p align="center">
<strong>Understand Anything. <a href="https://egonex.ai">Understand Anyone.</a></strong>
<br />
<em>La IA debería ayudar a las personas, no reemplazarlas.</em>
</p>

<p align="center">
<a href="https://trendshift.io/repositories/23482" target="_blank"><img src="https://trendshift.io/api/badge/repositories/23482" alt="Understand Anything | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
</p>
Expand All @@ -22,8 +28,11 @@
<a href="#copilot-cli"><img src="https://img.shields.io/badge/Copilot_CLI-24292e" alt="Copilot CLI" /></a>
<a href="#gemini-cli"><img src="https://img.shields.io/badge/Gemini_CLI-4285F4" alt="Gemini CLI" /></a>
<a href="#opencode"><img src="https://img.shields.io/badge/OpenCode-38bdf8" alt="OpenCode" /></a>
<a href="#mistral-vibe-cli"><img src="https://img.shields.io/badge/Vibe_CLI-7c3aed" alt="Vibe CLI" /></a>
<a href="#trae"><img src="https://img.shields.io/badge/Trae-7e22ce" alt="Trae" /></a>
<a href="https://understand-anything.com"><img src="https://img.shields.io/badge/Página_Principal-d4a574" alt="Homepage" /></a>
<a href="https://understand-anything.com/demo/"><img src="https://img.shields.io/badge/Demo_en_Vivo-00c853" alt="Live Demo" /></a>
<a href="https://egonex.ai"><img src="https://img.shields.io/badge/Understand_Anyone-egonex.ai-d4a574" alt="Understand Anyone" /></a>
</p>

<p align="center">
Expand Down Expand Up @@ -128,10 +137,30 @@ Un pipeline multi-agente escanea tu proyecto, extrae cada archivo, función, cla
# Idiomas soportados: en (default), zh, zh-TW, ja, ko, ru
```

En la **primera ejecución** en un proyecto — cuando no pasas `--language` y no hay un idioma guardado aún — `/understand` detecta el idioma en el que estás conversando. Si no es inglés, te pide confirmar (o cambiar) antes de generar; las conversaciones en inglés no se ven afectadas. Tu elección se guarda en `.ua/config.json` y se reutiliza en cada ejecución posterior.

**Alias de extensiones tree-sitter a nivel de proyecto:** Si tu código usa extensiones de archivo personalizadas, puedes agregarlas a `.ua/config.json` (o al legacy `.understand-anything/config.json` si tu proyecto ya usa ese directorio):

```json
{
"treeSitter": {
"extensionLanguageMap": {
".customts": "typescript",
".custompy": "python"
}
}
}
```

Esto permite que `/understand` trate esas extensiones como el lenguaje especificado durante el escaneo estructural basado en tree-sitter.

El parámetro `--language` afecta:
- Resúmenes y descripciones de nodos en el grafo de conocimiento
- Etiquetas, botones y tooltips de la UI del dashboard
- Explicaciones de los tours guiados
- Salida de `/understand-domain` (nombres/resúmenes de dominios, flujos, pasos)
- Texto de la guía de incorporación generada por `/understand-onboard`
- Descripciones de entidades/afirmaciones/relaciones inferidas por `/understand-knowledge`

### 3. Explora el panel

Expand Down
18 changes: 18 additions & 0 deletions READMEs/README.ja-JP.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,10 +140,28 @@ Understand Anything は [Claude Code Plugin](https://code.claude.com/docs/en/plu

プロジェクトでの**初回実行時**に `--language` を指定せず、保存済みの言語設定もない場合、`/understand` は会話で使われている言語を検出します。英語以外が検出された場合は、生成前にその言語を使用するか、別の言語へ変更するかを確認します。英語での会話には影響しません。選択結果は `.ua/config.json` に保存され、以降の実行でも再利用されます。

**プロジェクトレベルの tree-sitter 拡張子エイリアス:** コードベースでカスタムファイル拡張子を使用している場合、`.ua/config.json` に追加できます(またはプロジェクトが既存の `.understand-anything/` ディレクトリを使用している場合はそのディレクトリの `config.json`):

```json
{
"treeSitter": {
"extensionLanguageMap": {
".customts": "typescript",
".custompy": "python"
}
}
}
```

これにより、`/understand` は tree-sitter ベースの構造スキャンでそれらの拡張子を指定された言語として扱います。

`--language` パラメータは以下に影響します:
- ナレッジグラフのノードサマリーと説明
- ダッシュボードUIのラベル、ボタン、ツールチップ
- ガイド付きツアーの説明
- `/understand-domain` の出力(ドメイン、フロー、ステップの名前/概要)
- `/understand-onboard` で生成されるオンボーディングガイドのテキスト
- `/understand-knowledge` で推論されるエンティティ/主張/関係の説明

### 3. ダッシュボードで探索

Expand Down
45 changes: 42 additions & 3 deletions READMEs/README.ko-KR.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<em>Claude Code, Codex, Cursor, Copilot, Gemini CLI 등 다양한 플랫폼을 지원합니다.</em>
</p>

<p align="center">
<strong>Understand Anything. <a href="https://egonex.ai">Understand Anyone.</a></strong>
<br />
<em>AI는 사람을 대체하는 것이 아니라, 사람을 도와야 합니다.</em>
</p>

<p align="center">
<a href="https://trendshift.io/repositories/23482" target="_blank"><img src="https://trendshift.io/api/badge/repositories/23482" alt="Understand Anything | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
</p>
Expand All @@ -22,8 +28,11 @@
<a href="#copilot-cli"><img src="https://img.shields.io/badge/Copilot_CLI-24292e" alt="Copilot CLI" /></a>
<a href="#gemini-cli"><img src="https://img.shields.io/badge/Gemini_CLI-4285F4" alt="Gemini CLI" /></a>
<a href="#opencode"><img src="https://img.shields.io/badge/OpenCode-38bdf8" alt="OpenCode" /></a>
<a href="#mistral-vibe-cli"><img src="https://img.shields.io/badge/Vibe_CLI-7c3aed" alt="Vibe CLI" /></a>
<a href="#trae"><img src="https://img.shields.io/badge/Trae-7e22ce" alt="Trae" /></a>
<a href="https://understand-anything.com"><img src="https://img.shields.io/badge/홈페이지-d4a574" alt="Homepage" /></a>
<a href="https://understand-anything.com/demo/"><img src="https://img.shields.io/badge/라이브_데모-00c853" alt="Live Demo" /></a>
<a href="https://egonex.ai"><img src="https://img.shields.io/badge/Understand_Anyone-egonex.ai-d4a574" alt="Understand Anyone" /></a>
</p>

<p align="center">
Expand Down Expand Up @@ -128,10 +137,30 @@ Understand Anything은 [Claude Code Plugin](https://code.claude.com/docs/en/plug
# 지원 언어: en(기본값), zh, zh-TW, ja, ko, ru
```

프로젝트에서의 **첫 실행 시** — `--language`를 지정하지 않고 저장된 언어 설정도 없을 때 — `/understand`는 대화에서 사용 중인 언어를 감지합니다. 영어가 아닌 것이 감지되면, 생성 전에 해당 언어를 사용할지 다른 언어로 변경할지 확인합니다. 영어 대화에는 영향이 없습니다. 선택 결과는 `.ua/config.json`에 저장되어 이후 실행에서도 재사용됩니다.

**프로젝트 수준 tree-sitter 확장 별칭:** 코드베이스에서 커스텀 파일 확장자를 사용하는 경우, `.ua/config.json`에 추가할 수 있습니다 (또는 프로젝트가 기존 `.understand-anything/` 디렉토리를 사용 중이라면 해당 디렉토리의 `config.json`):

```json
{
"treeSitter": {
"extensionLanguageMap": {
".customts": "typescript",
".custompy": "python"
}
}
}
```

이렇게 하면 `/understand`가 tree-sitter 기반 구조 스캔에서 해당 확장자를 지정된 언어로 처리합니다.

`--language` 매개변수는 다음에 영향합니다:
- 지식 그래프의 노드 요약과 설명
- 대시보드 UI의 레이블, 버튼, 툴팁
- 가이드 투어의 설명
- `/understand-domain` 출력 (도메인, 흐름, 단계의 이름/요약)
- `/understand-onboard` 생성된 온보딩 가이드 텍스트
- `/understand-knowledge` 추론된 엔티티/주장/관계 설명

### 3. 대시보드 탐색

Expand All @@ -145,7 +174,7 @@ Understand Anything은 [Claude Code Plugin](https://code.claude.com/docs/en/plug

```bash
# 코드베이스에 대해 무엇이든 질문하기
/understand-chat How does the payment flow work?
/understand-chat 결제 흐름은 어떻게 작동하나요?

# 현재 변경 사항의 영향 분석
/understand-diff
Expand All @@ -159,6 +188,15 @@ Understand Anything은 [Claude Code Plugin](https://code.claude.com/docs/en/plug
# 비즈니스 도메인 지식 추출 (도메인, 흐름, 단계)
/understand-domain

# 한국어로 도메인 지식 추출 (config.json에도 저장됨)
/understand-domain --language ko

# 한국어로 온보딩 가이드 생성
/understand-onboard --language ko

# 한국어로 Karpathy wiki 분석 및 추론된 지식 출력
/understand-knowledge ~/path/to/wiki --language ko

# Karpathy 패턴 LLM 위키 지식 베이스 분석
/understand-knowledge ~/path/to/wiki

Expand All @@ -185,7 +223,7 @@ Understand-Anything은 다양한 AI 코딩 플랫폼에서 사용할 수 있습
/plugin install understand-anything
```

### 한 줄 설치 (Codex / OpenCode / OpenClaw / Antigravity / Gemini CLI / Pi Agent / Vibe CLI / VS Code Copilot / Hermes / Cline / KIMI CLI / Nanobot / Kiro)
### 한 줄 설치 (Codex / OpenCode / OpenClaw / Antigravity / Gemini CLI / Pi Agent / Vibe CLI / VS Code Copilot / Hermes / Cline / KIMI CLI / Trae / Nanobot / Kiro)

**macOS / Linux:**
```bash
Expand All @@ -203,7 +241,7 @@ iwr -useb https://raw.githubusercontent.com/Egonex-AI/Understand-Anything/main/i

> **스킬 호출 방식 안내:** 호출 접두사는 플랫폼마다 다릅니다. 대부분의 플랫폼은 슬래시 명령(`/understand`)을 사용하지만, **Codex는 `$`를 사용합니다** — `/understand`가 아니라 `$understand`를 입력하세요. 두 접두사 모두 인식되지 않으면 *"understand 스킬로 이 프로젝트를 분석해 줘"* 처럼 자연어로 요청하면 됩니다.

- 지원되는 `<platform>` 값: `gemini`, `codex`, `opencode`, `pi`, `openclaw`, `antigravity`, `vibe`, `vscode`, `hermes`, `cline`, `kimi`, `nanobot`, `kiro`
- 지원되는 `<platform>` 값: `gemini`, `codex`, `opencode`, `pi`, `openclaw`, `antigravity`, `vibe`, `vscode`, `hermes`, `cline`, `kimi`, `trae`, `nanobot`, `kiro`
- 이후 업데이트: `./install.sh --update`
- 제거: `./install.sh --uninstall <platform>`

Expand Down Expand Up @@ -255,6 +293,7 @@ curl -fsSL https://raw.githubusercontent.com/Egonex-AI/Understand-Anything/main/
| Hermes | ✅ 지원 | `install.sh hermes` |
| Cline | ✅ 지원 | `install.sh cline` |
| KIMI CLI | ✅ 지원 | `install.sh kimi` |
| Trae | ✅ 지원 | `install.sh trae` |
| Nanobot | ✅ 지원 | `install.sh nanobot` |
| Kiro CLI / IDE | ✅ 지원 | `install.sh kiro` |

Expand Down
43 changes: 41 additions & 2 deletions READMEs/README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
<em>支持 Claude Code、Codex、Cursor、Copilot、Gemini CLI 等多平台。</em>
</p>

<p align="center">
<strong>Understand Anything. <a href="https://egonex.ai">Understand Anyone.</a></strong>
<br />
<em>AI 应该帮助人,而不是取代人。</em>
</p>

<p align="center">
<a href="https://trendshift.io/repositories/23482" target="_blank"><img src="https://trendshift.io/api/badge/repositories/23482" alt="Understand Anything | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
</p>
Expand All @@ -22,8 +28,11 @@
<a href="#copilot-cli"><img src="https://img.shields.io/badge/Copilot_CLI-24292e" alt="Copilot CLI" /></a>
<a href="#gemini-cli"><img src="https://img.shields.io/badge/Gemini_CLI-4285F4" alt="Gemini CLI" /></a>
<a href="#opencode"><img src="https://img.shields.io/badge/OpenCode-38bdf8" alt="OpenCode" /></a>
<a href="#mistral-vibe-cli"><img src="https://img.shields.io/badge/Vibe_CLI-7c3aed" alt="Vibe CLI" /></a>
<a href="#trae"><img src="https://img.shields.io/badge/Trae-7e22ce" alt="Trae" /></a>
<a href="https://understand-anything.com"><img src="https://img.shields.io/badge/项目主页-d4a574" alt="Homepage" /></a>
<a href="https://understand-anything.com/demo/"><img src="https://img.shields.io/badge/在线演示-00c853" alt="Live Demo" /></a>
<a href="https://egonex.ai"><img src="https://img.shields.io/badge/Understand_Anyone-egonex.ai-d4a574" alt="Understand Anyone" /></a>
</p>

<p align="center">
Expand Down Expand Up @@ -128,10 +137,30 @@ Understand Anything 是一个 [Claude Code Plugin](https://code.claude.com/docs/
# 支持的语言:en(默认)、zh、zh-TW、ja、ko、ru
```

在项目的**首次运行**时 —— 当你没有传入 `--language` 且尚未存储语言设置时 —— `/understand` 会检测你正在使用的语言。如果检测到非英语,它会询问你确认(或改用其他语言)后再生成;英语对话不受影响。你的选择会保存到 `.ua/config.json` 并在后续运行中复用。

**项目级 tree-sitter 扩展别名:** 如果你的代码库使用自定义文件扩展名,可以在 `.ua/config.json` 中添加(如果你的项目仍在使用旧版 `.understand-anything/` 目录,也可以使用该目录下的 `config.json`):

```json
{
"treeSitter": {
"extensionLanguageMap": {
".customts": "typescript",
".custompy": "python"
}
}
}
```

这样 `/understand` 在基于 tree-sitter 的结构扫描时就会将这些扩展名视为指定语言。

`--language` 参数会影响:
- 知识图谱中的节点摘要和描述
- Dashboard UI 的标签、按钮和提示
- 导览路线的解释说明
- `/understand-domain` 输出(领域、流程、步骤的名称/摘要)
- `/understand-onboard` 生成的入门指南文本
- `/understand-knowledge` 推断的实体/论断/关系描述

### 3. 打开数据看板

Expand Down Expand Up @@ -159,6 +188,15 @@ Understand Anything 是一个 [Claude Code Plugin](https://code.claude.com/docs/
# 提取业务领域知识(领域、流程、步骤)
/understand-domain

# 以中文提取领域知识(也会保存到 config.json)
/understand-domain --language zh

# 以中文生成入门指南
/understand-onboard --language zh

# 以中文分析 Karpathy wiki 并输出推断的知识
/understand-knowledge ~/path/to/wiki --language zh

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

Expand All @@ -185,7 +223,7 @@ Understand-Anything 可在多个 AI 编码平台上运行。
/plugin install understand-anything
```

### 一行命令安装(Codex / OpenCode / OpenClaw / Antigravity / Gemini CLI / Pi Agent / Vibe CLI / VS Code Copilot / Hermes / Cline / KIMI CLI / Nanobot / Kiro)
### 一行命令安装(Codex / OpenCode / OpenClaw / Antigravity / Gemini CLI / Pi Agent / Vibe CLI / VS Code Copilot / Hermes / Cline / KIMI CLI / Trae / Nanobot / Kiro)

**macOS / Linux:**
```bash
Expand All @@ -203,7 +241,7 @@ iwr -useb https://raw.githubusercontent.com/Egonex-AI/Understand-Anything/main/i

> **关于技能调用方式:** 不同平台的调用前缀不同。大多数平台使用斜杠命令(`/understand`),但 **Codex 使用 `$`** —— 请输入 `$understand`,而不是 `/understand`。如果两种前缀都不被识别,直接用自然语言请求即可:*“使用 understand 技能分析这个项目”*。

- 支持的 `<platform>` 取值:`gemini`、`codex`、`opencode`、`pi`、`openclaw`、`antigravity`、`vibe`、`vscode`、`hermes`、`cline`、`kimi`、`nanobot`、`kiro`
- 支持的 `<platform>` 取值:`gemini`、`codex`、`opencode`、`pi`、`openclaw`、`antigravity`、`vibe`、`vscode`、`hermes`、`cline`、`kimi`、`trae`、`nanobot`、`kiro`
- 后续更新:`./install.sh --update`
- 卸载:`./install.sh --uninstall <platform>`

Expand Down Expand Up @@ -255,6 +293,7 @@ curl -fsSL https://raw.githubusercontent.com/Egonex-AI/Understand-Anything/main/
| Hermes | ✅ 支持 | `install.sh hermes` |
| Cline | ✅ 支持 | `install.sh cline` |
| KIMI CLI | ✅ 支持 | `install.sh kimi` |
| Trae | ✅ 支持 | `install.sh trae` |
| Nanobot | ✅ 支持 | `install.sh nanobot` |
| Kiro CLI / IDE | ✅ 支持 | `install.sh kiro` |

Expand Down
Loading