Skip to content

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

Open
pea3nut wants to merge 3 commits intoPatrickJS:mainfrom
pea3nut:add-agent-add-install
Open

docs: add agent-add cross-host install as Method Two in How to Use#240
pea3nut wants to merge 3 commits intoPatrickJS:mainfrom
pea3nut:add-agent-add-install

Conversation

@pea3nut
Copy link
Copy Markdown

@pea3nut pea3nut commented Apr 8, 2026

Summary

Adds a Method Two under ## How to Use using 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

  • Documentation
    • Renamed "Method Two" to "Method Two (cross-host via agent-add)" and updated the navigation.
    • Added a new "Method Three" entry; preserved existing Cursor-extension tutorial steps.
    • Expanded Method Two with guidance on auto-detecting the AI host and linking to the agent-add installer.
    • Included two concrete shell command examples (templated and stack-specific) to simplify setup.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 8, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5f48372f-5165-472b-84cf-c622efa6d3d5

📥 Commits

Reviewing files that changed from the base of the PR and between 982e31c and a735bf8.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

Updated README: renamed "Method Two" to "Method Two (cross-host via agent-add)" and inserted instructions for the agent-add cross-host installer, including npx -y agent-add --prompt '<rule-dir>' examples and a concrete Next.js + React + Vercel AI + Tailwind ruleset example; "Method Three" remains unchanged.

Changes

Cohort / File(s) Summary
Documentation Update
README.md
Renamed "Method Two" to "Method Two (cross-host via agent-add)". Added cross-host installer description for agent-add, two npx -y agent-add --prompt '<rule-dir>' command examples (templated and concrete), and an explicit Next.js 15 + React 19 + Vercel AI + Tailwind ruleset example. "Method Three" left intact.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped to the README to give it a nudge,
Agent-add now dances across hosts with a judge,
Templates and examples tucked neatly inside,
Rules for Next.js ready for the ride,
A tiny rabbit cheers — docs updated with pride!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately and concisely describes the main change: adding agent-add cross-host install documentation as Method Two in the How to Use section, which directly matches the README.md updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 778212d4-4678-42c6-a649-efd33eebdbef

📥 Commits

Reviewing files that changed from the base of the PR and between fc2ce04 and 982e31c.

📒 Files selected for processing (1)
  • README.md

### 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

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

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

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant