diff --git a/understand-anything-plugin/.codex/INSTALL.md b/understand-anything-plugin/.codex/INSTALL.md new file mode 100644 index 0000000..155ade1 --- /dev/null +++ b/understand-anything-plugin/.codex/INSTALL.md @@ -0,0 +1,55 @@ +# Installing Understand-Anything for Codex + +## Prerequisites + +- Git + +## Installation + +1. **Clone the repository:** + ```bash + git clone https://github.com/Lum1104/Understand-Anything.git ~/.codex/understand-anything + ``` + +2. **Create the skills symlink:** + ```bash + mkdir -p ~/.agents/skills + ln -s ~/.codex/understand-anything/understand-anything-plugin/skills ~/.agents/skills/understand-anything + ``` + + **Windows (PowerShell):** + ```powershell + New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.agents\skills" + cmd /c mklink /J "$env:USERPROFILE\.agents\skills\understand-anything" "$env:USERPROFILE\.codex\understand-anything\understand-anything-plugin\skills" + ``` + +3. **Restart Codex** to discover the skills. + +## Verify + +```bash +ls -la ~/.agents/skills/understand-anything +``` + +You should see a symlink pointing to the skills directory. + +## Usage + +Skills activate automatically when relevant. You can also invoke directly: +- "Analyze this codebase and build a knowledge graph" +- "Help me understand this project's architecture" + +## Updating + +```bash +cd ~/.codex/understand-anything && git pull +``` + +Skills update instantly through the symlink. + +## Uninstalling + +```bash +rm ~/.agents/skills/understand-anything +rm -rf ~/.codex/understand-anything +``` diff --git a/understand-anything-plugin/.cursor/INSTALL.md b/understand-anything-plugin/.cursor/INSTALL.md new file mode 100644 index 0000000..3eadc06 --- /dev/null +++ b/understand-anything-plugin/.cursor/INSTALL.md @@ -0,0 +1,37 @@ +# Installing Understand-Anything for Cursor + +## Prerequisites + +- Git + +## Installation + +1. **Clone the repository:** + ```bash + git clone https://github.com/Lum1104/Understand-Anything.git ~/.cursor/understand-anything + ``` + +2. **Create the plugin symlink:** + ```bash + mkdir -p ~/.cursor/plugins + ln -s ~/.cursor/understand-anything/understand-anything-plugin ~/.cursor/plugins/understand-anything + ``` + +3. **Restart Cursor** to discover the plugin. + +## Usage + +Skills activate automatically when relevant. Use `/understand` to analyze a codebase. + +## Updating + +```bash +cd ~/.cursor/understand-anything && git pull +``` + +## Uninstalling + +```bash +rm ~/.cursor/plugins/understand-anything +rm -rf ~/.cursor/understand-anything +``` diff --git a/understand-anything-plugin/.openclaw/INSTALL.md b/understand-anything-plugin/.openclaw/INSTALL.md new file mode 100644 index 0000000..56ead38 --- /dev/null +++ b/understand-anything-plugin/.openclaw/INSTALL.md @@ -0,0 +1,39 @@ +# Installing Understand-Anything for OpenClaw + +## Prerequisites + +- Git + +## Installation + +1. **Clone the repository:** + ```bash + git clone https://github.com/Lum1104/Understand-Anything.git ~/.openclaw/understand-anything + ``` + +2. **Create the skills symlink:** + ```bash + mkdir -p ~/.openclaw/skills + ln -s ~/.openclaw/understand-anything/understand-anything-plugin/skills ~/.openclaw/skills/understand-anything + ``` + +3. **Restart OpenClaw** to discover the skills. + +## Usage + +- `@understand` — Analyze the current codebase +- `@understand-chat` — Ask questions about the knowledge graph +- `@understand-dashboard` — Launch the interactive dashboard + +## Updating + +```bash +cd ~/.openclaw/understand-anything && git pull +``` + +## Uninstalling + +```bash +rm ~/.openclaw/skills/understand-anything +rm -rf ~/.openclaw/understand-anything +``` diff --git a/understand-anything-plugin/.opencode/INSTALL.md b/understand-anything-plugin/.opencode/INSTALL.md new file mode 100644 index 0000000..6cac25a --- /dev/null +++ b/understand-anything-plugin/.opencode/INSTALL.md @@ -0,0 +1,37 @@ +# Installing Understand-Anything for OpenCode + +## Prerequisites + +- [OpenCode.ai](https://opencode.ai) installed + +## Installation + +Add understand-anything to the `plugin` array in your `opencode.json` (global or project-level): + +```json +{ + "plugin": ["understand-anything@git+https://github.com/Lum1104/Understand-Anything.git"] +} +``` + +Restart OpenCode. The plugin auto-installs and registers all skills. + +## Verify + +Ask: "List available skills" — you should see understand, understand-chat, understand-dashboard, etc. + +## Usage + +``` +use skill tool to load understand-anything/understand +``` + +Or just ask: "Analyze this codebase and build a knowledge graph" + +## Updating + +Restart OpenCode — the plugin re-installs from git automatically. + +## Uninstalling + +Remove the plugin line from `opencode.json` and restart.