diff --git a/README.md b/README.md index 63c6a2ff..d47a20dc 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,8 @@ By creating a `.cursorrules` file in your project's root directory, you can leve - [Directories](#directories) - [How to Use](#how-to-use) - [Method One](#method-one) - - [Method Two](#method-two) + - [Method Two (cross-host via agent-add)](#method-two-cross-host-via-agent-add) + - [Method Three](#method-three) - [Contributing](#contributing) - [Sponsorships](#sponsorships-1) - [License](#license) @@ -301,7 +302,22 @@ By creating a `.cursorrules` file in your project's root directory, you can leve 3. Copy the chosen `.cursorrules` file to your project's root directory. 4. Customize the rules as needed for your specific project requirements. -### Method Two +### Method Two (cross-host via agent-add) + +[agent-add](https://github.com/pea3nut/agent-get) is a cross-host installer that auto-detects your AI host (18 supported: Cursor, Claude Code, Claude Desktop, Windsurf, GitHub Copilot, Gemini, Roo Code, Kilo Code, Qwen Code, OpenCode, Kiro, Codex, and more) and writes any rule from this repo to the correct location: + +```bash +# Install a specific rule (replace with any directory from the Rules list above) +npx -y agent-add --prompt 'https://raw.githubusercontent.com/PatrickJS/awesome-cursorrules/main/rules//.cursorrules' +``` + +Example — install the Next.js 15 + React 19 + Vercel AI + Tailwind rule: + +```bash +npx -y agent-add --prompt 'https://raw.githubusercontent.com/PatrickJS/awesome-cursorrules/main/rules/nextjs15-react19-vercelai-tailwind-cursorrules-prompt-file/.cursorrules' +``` + +### Method Three 1. Install [Cursor AI](https://cursor.sh/) if you haven't already. 2. Install [vscode-cursor-rules](https://marketplace.visualstudio.com/items?itemName=BeilunYang.cursor-rules) extension.