diff --git a/.copilot-plugin/plugin.json b/.copilot-plugin/plugin.json new file mode 100644 index 0000000..cadcb4c --- /dev/null +++ b/.copilot-plugin/plugin.json @@ -0,0 +1,14 @@ +{ + "name": "understand-anything", + "description": "AI-powered codebase understanding — analyze, visualize, and explain any project", + "version": "2.0.0", + "author": { + "name": "Lum1104" + }, + "homepage": "https://github.com/Lum1104/Understand-Anything", + "repository": "https://github.com/Lum1104/Understand-Anything", + "license": "MIT", + "keywords": ["codebase-analysis", "knowledge-graph", "architecture", "onboarding", "dashboard"], + "skills": "./understand-anything-plugin/skills/", + "agents": "./understand-anything-plugin/agents/" +} diff --git a/.vscode/INSTALL.md b/.vscode/INSTALL.md new file mode 100644 index 0000000..81b895e --- /dev/null +++ b/.vscode/INSTALL.md @@ -0,0 +1,82 @@ +# Installing Understand-Anything for VS Code + GitHub Copilot + +## Prerequisites + +- [VS Code](https://code.visualstudio.com/) with the [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) extension (v1.108+) +- Git + +## Option A — Auto-discovery (recommended) + +Clone this repo and open it in VS Code. GitHub Copilot automatically discovers the plugin via `.copilot-plugin/plugin.json` — no manual steps required. + +```bash +git clone https://github.com/Lum1104/Understand-Anything.git +code Understand-Anything +``` + +Skills will appear when you type `/` in GitHub Copilot Chat. + +## Option B — Personal skills (available across all projects) + +1. **Clone the repository** (to any location you prefer): + ```bash + git clone https://github.com/Lum1104/Understand-Anything.git ~/understand-anything + ``` + +2. **Create a symlink for each skill** into `~/.copilot/skills/`: + ```bash + mkdir -p ~/.copilot/skills + SKILLS_DIR=~/understand-anything/understand-anything-plugin/skills + for skill in "$SKILLS_DIR"/*/; do + ln -sf "$skill" ~/.copilot/skills/$(basename "$skill") + done + # Universal plugin root symlink — lets the dashboard skill find packages/dashboard/ + # Skip if already exists (e.g. another platform was installed first) + [ -e ~/.understand-anything-plugin ] || [ -L ~/.understand-anything-plugin ] || \ + ln -s ~/understand-anything/understand-anything-plugin ~/.understand-anything-plugin + ``` + + **Windows (PowerShell):** + ```powershell + New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.copilot\skills" + $skillsDir = "$env:USERPROFILE\understand-anything\understand-anything-plugin\skills" + Get-ChildItem $skillsDir -Directory | ForEach-Object { + cmd /c mklink /J "$env:USERPROFILE\.copilot\skills\$($_.Name)" $_.FullName + } + cmd /c mklink /J "$env:USERPROFILE\.understand-anything-plugin" "$env:USERPROFILE\understand-anything\understand-anything-plugin" + ``` + +3. **Reload VS Code** (`Cmd+Shift+P` → `Developer: Reload Window`) so GitHub Copilot discovers the skills. + +## Verify + +Type `/` in GitHub Copilot Chat — you should see all six skills listed: + +- `understand` — build the knowledge graph +- `understand-chat` — ask questions about the codebase +- `understand-dashboard` — open the interactive dashboard +- `understand-diff` — analyze impact of current changes +- `understand-explain` — deep-dive into a file or function +- `understand-onboard` — generate an onboarding guide + +## Usage + +Skills activate automatically when relevant. You can also invoke them directly by typing `/` in Copilot Chat and selecting a skill. + +## Updating + +```bash +cd ~/understand-anything && git pull +``` + +Skills update instantly through the symlinks. + +## Uninstalling + +```bash +for skill in understand understand-chat understand-dashboard understand-diff understand-explain understand-onboard; do + rm -f ~/.copilot/skills/$skill +done +rm -f ~/.understand-anything-plugin +rm -rf ~/understand-anything +``` diff --git a/README.ja-JP.md b/README.ja-JP.md index bad5000..cba437e 100644 --- a/README.ja-JP.md +++ b/README.ja-JP.md @@ -5,7 +5,7 @@
- English | 中文 | 日本語 | Türkçe + English | 简体中文 | 繁體中文 | 日本語 | Türkçe
@@ -138,6 +138,15 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und 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に以下を伝えてください: @@ -168,6 +177,7 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und | OpenCode | ✅ サポート | AI駆動インストール | | OpenClaw | ✅ サポート | AI駆動インストール | | Cursor | ✅ サポート | 自動検出 | +| VS Code + GitHub Copilot | ✅ サポート | 自動検出 | | Antigravity | ✅ サポート | AI駆動インストール | | Gemini CLI | ✅ サポート | AI駆動インストール | | Pi Agent | ✅ サポート | AI駆動インストール | diff --git a/README.md b/README.md index 999fb49..7668fe3 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@
- English | 中文 | 日本語 | Türkçe + English | 简体中文 | 繁體中文 | 日本語 | Türkçe
@@ -138,6 +138,15 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und Cursor auto-discovers the plugin via `.cursor-plugin/plugin.json` when this repo is cloned. No manual installation needed — just clone and open in Cursor. +### VS Code + GitHub Copilot + +VS Code with GitHub Copilot (v1.108+) auto-discovers the plugin via `.copilot-plugin/plugin.json` when this repo is cloned. No manual installation needed — just clone and open in VS Code. + +For personal skills (available across all projects), tell GitHub Copilot: +```text +Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.vscode/INSTALL.md +``` + ### Antigravity Tell Antigravity: @@ -168,6 +177,7 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und | OpenCode | ✅ Supported | AI-driven install | | OpenClaw | ✅ Supported | AI-driven install | | Cursor | ✅ Supported | Auto-discovery | +| VS Code + GitHub Copilot | ✅ Supported | Auto-discovery | | Antigravity | ✅ Supported | AI-driven install | | Gemini CLI | ✅ Supported | AI-driven install | | Pi Agent | ✅ Supported | AI-driven install | diff --git a/README.tr-TR.md b/README.tr-TR.md index b39fccb..26e9fe6 100644 --- a/README.tr-TR.md +++ b/README.tr-TR.md @@ -5,7 +5,7 @@
- English | 中文 | 日本語 | Türkçe + English | 简体中文 | 繁體中文 | 日本語 | Türkçe
@@ -138,6 +138,15 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und Bu depo klonlandığında Cursor, eklentiyi `.cursor-plugin/plugin.json` aracılığıyla otomatik olarak keşfeder. Manuel kurulum gerekmez — sadece klonla ve Cursor'da aç. +### VS Code + GitHub Copilot + +GitHub Copilot uzantısı (v1.108+) yüklü VS Code, `.copilot-plugin/plugin.json` aracılığıyla eklentiyi otomatik keşfeder. Manuel kurulum gerekmez — sadece klonla ve VS Code'da aç. + +Tüm projelerde kullanmak için kişisel beceri olarak kurmak istersen GitHub Copilot'a söyle: +```text +Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Understand-Anything/refs/heads/main/.vscode/INSTALL.md +``` + ### Antigravity Antigravity'e söyle: @@ -168,6 +177,7 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und | OpenCode | ✅ Destekleniyor | AI güdümlü kurulum | | OpenClaw | ✅ Destekleniyor | AI güdümlü kurulum | | Cursor | ✅ Destekleniyor | Otomatik keşif | +| VS Code + GitHub Copilot | ✅ Destekleniyor | Otomatik keşif | | Antigravity | ✅ Destekleniyor | AI güdümlü kurulum | | Gemini CLI | ✅ Destekleniyor | AI güdümlü kurulum | | Pi Agent | ✅ Destekleniyor | AI güdümlü kurulum | diff --git a/README.zh-CN.md b/README.zh-CN.md index 79b4ad9..d882861 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -4,7 +4,7 @@
- English | 中文 | 日本語 | Türkçe + English | 简体中文 | 繁體中文 | 日本語 | Türkçe
@@ -137,6 +137,15 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und 克隆此仓库后,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: @@ -167,6 +176,7 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und | OpenCode | ✅ 支持 | AI驱动安装 | | OpenClaw | ✅ 支持 | AI驱动安装 | | Cursor | ✅ 支持 | 自动发现 | +| VS Code + GitHub Copilot | ✅ 支持 | 自动发现 | | Antigravity | ✅ 支持 | AI驱动安装 | | Gemini CLI | ✅ 支持 | AI驱动安装 | | Pi Agent | ✅ 支持 | AI驱动安装 | diff --git a/README.zh-TW.md b/README.zh-TW.md new file mode 100644 index 0000000..3da4ea7 --- /dev/null +++ b/README.zh-TW.md @@ -0,0 +1,313 @@ +
+ 將任意程式碼庫轉化為可探索、可搜尋、可對話的互動式知識圖譜 +
+ ++ English | 简体中文 | 繁體中文 | 日本語 | Türkçe +
+ + + +
+
+
+ 👩💻 入門級開發者+不再被陌生程式碼淹沒。透過結構化引導逐步理解系統架構,每個函式和類別都有簡明易懂的解釋。 + |
+
+ 📋 產品經理 & 設計師+無需閱讀程式碼,也能理解系統邏輯。比如直接提問:「認證流程是怎麼實作的?」便可獲得基於實際程式碼庫的清晰答案。 + |
+
+ 🤖 AI 協同開發者+讓你的 AI 工具深入了解你的專案。在程式碼審查之前使用 |
+
+
+
+ 🗺️ 互動式知識圖譜+使用 React Flow 視覺化檔案、函式、類別及其關係。點擊任意節點即可查看其程式碼和連接。 + |
+
+ 💬 簡明語言解釋+LLM 自動產生解釋,讓非技術人員也能理解程式碼。 + |
+
+ 🧭 引導式學習+自動產生架構學習路徑,按相依順序學習。 + |
+
+ 🔍 語意搜尋+支援模糊搜尋 + 語意搜尋,例如搜尋「哪些部分處理身分驗證?」即可在整個圖中獲取相關結果。 + |
+
+ 📊 變更影響分析+提交變更前,查看變更會影響系統的哪些部分。了解變更對整個程式碼庫的連鎖反應。 + |
+
+ 🎭 使用者角色自適應 UI+根據使用者類型(初級開發 / 專案經理 / 進階使用者)調整其詳細程度。 + |
+
+ 🏗️ 層級視覺化+按架構層級自動分組 — API、服務、資料、UI、系統工具 — 並附有顏色編碼圖例。 + |
+
+ 📚 語言概念+12 種程式設計模式(泛型、閉包、裝飾器等)將在上下文中逐一解釋。 + |
+
+ 不再盲讀程式碼,而是理解整個系統 +
+ +## Star 歷史記錄 + + ++ MIT 授權條款 © Lum1104 +