Skip to content
OpenPlanr Docs
LearnGitHub (opens in a new tab)

OpenPlanr in Cursor

Install OpenPlanr skills in Cursor with the standard installer, or use the companion CLI to manage project rules.

OpenPlanr's skills run inside Cursor. Install individual skills with the standard installer, or use the companion CLI to generate Cursor project rules.

Install individual skills

Run this in a normal terminal from your project:

bash
npx skills add openplanr/OpenPlanr

Choose the skills, Cursor, and Project or Global scope. Project scope is the default. The installer places the source skill folders where Cursor can discover them.

Restart Cursor after installation and select an installed skill such as planr-ship with your request. Choose one installation method per host to avoid duplicate discovery.

Use CLI-managed project rules

If you prefer Cursor rules, install the companion CLI and run this inside your project:

bash
openplanr setup --runtime cursor --scope project

Setup shows what it will write before applying changes, then adds thin .mdc discovery rules under .cursor/rules/openplanr/. This CLI-managed route requires a Git repository or an initialized OpenPlanr project and supports project scope only.

Restart Cursor after setup. Mention the skill's rule in chat, such as planr-ship, with your request. The Cursor command examples in these docs describe this rules route; use the installed skill name if you chose the standard skills installer.

Add the companion CLI when needed

Diagram rendering, local studios, planning validation, diagnostics, and integrations use the companion CLI:

bash
npm install -g openplanr

See Install and set up OpenPlanr for requirements and structured planning setup.

When something goes wrong

  • A skill is missing. Confirm which installation method and scope you used, then restart Cursor and check its skill picker.
  • Individual skills need an update. Use npx skills update for skills installed through that installer.
  • CLI-managed setup reports E_PROJECT_CONTEXT_REQUIRED. Change into a Git repository or an initialized OpenPlanr project before running setup.
  • A CLI-managed rule is missing. Run openplanr doctor --json, then restart Cursor.
  • You want to remove it. Use the installer that installed it. openplanr runtime remove cursor removes only an installation managed by OpenPlanr setup.

More fixes are in Troubleshooting, and the host matrix shows what differs between agents.