Skip to content

docs: add agent-add cross-host install as Method Two in How to Use #240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pea3nut wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add agent-add cross-host install as Method Two in How to Use #240

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
47ed8eb
docs: add Method Three — agent-add cross-host install
pea3nut Apr 8, 2026
982e31c
docs: add agent-add as Method Two, renumber vscode extension to Metho…
pea3nut Apr 8, 2026
a735bf8
docs: update Contents TOC for new Method Two and Method Three
pea3nut Apr 8, 2026
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
20 changes: 18 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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:
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 8, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

New markdown link does not follow the repository’s relative-link rule.

The added agent-add hyperlink is absolute. Please convert it to a relative link if the target exists in-repo, or document/confirm an exception for external references.

As per coding guidelines, "Ensure all links in the README.md file are relative and correct."

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 306, The README contains an absolute hyperlink for
"agent-add" which violates the repo's relative-link rule; update the link text
"agent-add" to use the repository-relative path (e.g., the local path to the
agent-get directory or README within it) if that target exists in-repo,
otherwise document/confirm an explicit exception in the README; ensure the
updated link is relative and that the link target resolves correctly in the
repo.

Copy link
Copy Markdown
Author

@pea3nut pea3nut Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review! The agent-add link is unavoidably absolute because it points to an external repository (pea3nut/agent-get), not an in-repo file. The existing README already uses absolute external links in a similar way — for example the new ### Method Three block links to https://cursor.sh/ and https://marketplace.visualstudio.com/..., and ### Method One links to https://cursor.sh/ as well. So this PR follows the same convention as the existing Method One/Three.

Happy to switch to a footnote-style reference link or move the URL to a ## Resources section if @PatrickJS prefers — just let me know.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!


```bash
# Install a specific rule (replace <rule-dir> with any directory from the Rules list above)
npx -y agent-add --prompt 'https://raw.githubusercontent.com/PatrickJS/awesome-cursorrules/main/rules/<rule-dir>/.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

Comment thread
coderabbitai[bot] marked this conversation as resolved.
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.
Expand Down