Skip to content

docs(agent-compatibility): use copies for local install - #458

Open
dajiaohuang wants to merge 1 commit into
cursor:mainfrom
dajiaohuang:docs/agent-compatibility-local-install
Open

dajiaohuang wants to merge 1 commit into
cursor:mainfrom
dajiaohuang:docs/agent-compatibility-local-install

Conversation

@dajiaohuang

@dajiaohuang dajiaohuang commented Sep 29, 2026 •

Copy link
Copy Markdown

Summary

  • Replace the symlink-only local install example with a copy-based command.
  • Explain that Cursor skips links whose targets resolve outside ~/.cursor/plugins/local, which is typical for a repository clone.

Related to #35.

Validation

  • Confirmed the current Cursor plugin docs describe the external-symlink limitation.
  • git diff --check passed.

Note

Low Risk
Documentation-only change to local install instructions; no runtime or plugin behavior is modified.

Overview
Updates local install guidance in agent-compatibility/README.md so developers copy the plugin into ~/.cursor/plugins/local/ instead of symlinking from a clone.

The install example now uses cp -R rather than a symlink path, and a short note explains that Cursor ignores symlinks in that folder when the target lives outside the plugins directory—which is the usual case for a repo checkout—so copying is the right approach for local testing.

Reviewed by Cursor Bugbot for commit 66859f7. Bugbot is set up for automated code reviews on this repo. Configure here.

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