diff --git a/.copilot-plugin/plugin.json b/.copilot-plugin/plugin.json new file mode 100644 index 0000000..c1a0f00 --- /dev/null +++ b/.copilot-plugin/plugin.json @@ -0,0 +1,15 @@ +{ + "name": "understand-anything", + "displayName": "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..5e52ea6 --- /dev/null +++ b/.vscode/INSTALL.md @@ -0,0 +1,78 @@ +# 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 in the **Configure Skills** menu inside GitHub Copilot Chat. + +## Option B — Personal skills (available across all projects) + +1. **Clone the repository:** + ```bash + git clone https://github.com/Lum1104/Understand-Anything.git ~/.copilot/understand-anything + ``` + +2. **Create the skills symlink:** + ```bash + mkdir -p ~/.copilot/skills + ln -s ~/.copilot/understand-anything/understand-anything-plugin/skills ~/.copilot/skills/understand-anything + # 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 ~/.copilot/understand-anything/understand-anything-plugin ~/.understand-anything-plugin + ``` + + **Windows (PowerShell):** + ```powershell + New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.copilot\skills" + cmd /c mklink /J "$env:USERPROFILE\.copilot\skills\understand-anything" "$env:USERPROFILE\.copilot\understand-anything\understand-anything-plugin\skills" + cmd /c mklink /J "$env:USERPROFILE\.understand-anything-plugin" "$env:USERPROFILE\.copilot\understand-anything\understand-anything-plugin" + ``` + +3. **Restart VS Code** so GitHub Copilot can discover the skills. + +## Verify + +Open GitHub Copilot Chat → click **Configure Skills** — you should see the `understand-*` skills listed. + +## Usage + +Skills activate automatically when relevant. You can also invoke them directly in Copilot Chat: + +- "Run the understand skill to analyze this codebase" +- "Use understand-dashboard to view the architecture map" +- "Use understand-chat to answer a question about the graph" + +Or use the equivalent slash commands if you have Claude Code installed alongside: +- `/understand` — build the knowledge graph +- `/understand-dashboard` — open the interactive dashboard +- `/understand-chat ` — ask questions about the codebase +- `/understand-diff` — analyze impact of current changes +- `/understand-explain ` — deep-dive into a file or function +- `/understand-onboard` — generate an onboarding guide + +## Updating + +```bash +cd ~/.copilot/understand-anything && git pull +``` + +Skills update instantly through the symlink. + +## Uninstalling + +```bash +rm ~/.copilot/skills/understand-anything +rm ~/.understand-anything-plugin +rm -rf ~/.copilot/understand-anything +``` diff --git a/README.md b/README.md index 999fb49..d49bca1 100644 --- a/README.md +++ b/README.md @@ -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.zh-CN.md b/README.zh-CN.md index 79b4ad9..1d0ddd0 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -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驱动安装 |