GroundRules (Cursor Extension)

GroundRules is a Cursor extension that helps you to see the coverage of your custom Cursor rules.

NOTE: This extension currently only works in Cursor. It will not be able to analyze your rules if you install the extension in VSCode or Windsurf.

Installation

Visit GroundRules.ai to download and install the extension.

Configuration

You can change which models are used by setting the groundrules.analysisModel in the settings.

1. Open the Command Palette by pressing Ctrl+Shift+P.
2. Search for Open VSCode Settings and select it.
3. Search for groundrules.
4. Select the model you want to use.

Once you have set the model, you will need to set the API keys for the model provider you have chosen:

1. Open the Command Palette by pressing Ctrl+Shift+P.
2. Search for GroundRules: Set API Key and select the API provider you want to use.
3. Enter your API key and press Enter.

Analyze Rules

You can double-click on any .mdc file to open the GroundRules editor. Once you have opened the editor, you can click the Analyze button to see the coverage of your custom Cursor rules.

When the analysis is complete, you should see red and green highlights applied to your rules in the editor. Click on any rules to see the coverage of the rule.

Relevant Conversations are conversations which involved tasks which were related to the selected rule.

Redundant Conversations are conversations where the rule was relevant but was not needed as the rule behavior was already implied by the context available to the model.

Generate Rules

If you don't have any rules, you can generate them importing the metarules.

1. Open the Command Palette by pressing Ctrl+Shift+P.
2. Search for GroundRules: Import Metarules and select it.

This will add a new file called .cursor/rules/metarules.mdc to your project. To create new rules using the metarules:

1. Start a new chat in the Cursor sidebar.
2. Select the metarules.mdc file as context.
3. Prompt the AI to generate new rules. For example: "Create rules for a TypeScript React web app that uses Tailwind CSS."

Import Rules

Once you have a set of rules that you are happy with, you can create a common git repository to version them and then easily import them into any new project.

1. Open the Command Palette by pressing Ctrl+Shift+P.
2. Search for Open VSCode Settings and select it.
3. Search for groundrules.
4. Set the groundrules.importRulesDirectory to the local path of the directory containing your rules.

Once you have set the import directory, you can import the rules into a new project by running the following command:

1. Open the Command Palette by pressing Ctrl+Shift+P.
2. Search for GroundRules: Import Rules and select it.
3. Select the rules you want to import.

Privacy Policy

GroundRules collects anonymized usage statistics to improve the extension. No personal information is collected. Your code and custom rules are never recorded or stored. You can opt out of sharing usage statistics by setting the groundrules.analyticsEnabled setting to false.