docs: add agent-add cross-host install as Method Two in How to Use#240
docs: add agent-add cross-host install as Method Two in How to Use#240pea3nut wants to merge 3 commits into
Conversation
Added instructions for installing rules via agent-add.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughUpdated README: renamed "Method Two" to "Method Two (cross-host via agent-add)" and inserted instructions for the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- 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.
- Around line 304-320: Update the README Table of Contents so its entries match
the actual heading texts and anchors after renaming Method Two to "Method Two
(cross-host via agent-add)" and adding "Method Three"; specifically, ensure the
TOC links point to the exact heading strings used (e.g., "Method Two (cross-host
via agent-add)" and "Method Three") so the anchors resolve correctly and no
stale/missing TOC entries remain.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ### 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: |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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!
|
Thanks for the suggestion. I am closing this because README-only external listings are the pattern that has been turning into ads here, and this does not add reusable rule content to the repo. If you still feel it should be added, please rework and resubmit it as a repo-focused contribution with actual Cursor rule content plus a neutral README entry. |
2 participants
Summary
Adds a Method Two under
## How to Useusing agent-add — a cross-host installer that auto-detects the user's AI host (18 supported: Cursor, Claude Code, Windsurf, GitHub Copilot, Gemini, Roo Code, Kilo Code, OpenCode, and more) and writes any rule from this repo to the correct location:npx -y agent-add --prompt 'https://raw.githubusercontent.com/PatrickJS/awesome-cursorrules/main/rules/nextjs15-react19-vercelai-tailwind-cursorrules-prompt-file/.cursorrules'The existing Method One (manual copy) is unchanged; the previous Method Two (vscode-cursor-rules extension) is renumbered to Method Three. Docs-only addition.
Summary by CodeRabbit