rule-updater

Parse frontmatter and update Cursor rule files from PRs and issues.

13.1k|2.2k|Updated Mar 22, 2024
One-click install
npx skills add https://github.com/BasedHardware/omi --skill rule-updater
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rule-updater
Source: https://github.com/BasedHardware/omi/tree/main/.cursor/skills/rule-updater
Command: npx skills add https://github.com/BasedHardware/omi --skill rule-updater

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill enables programmatic reading, updating, and creation of Cursor rules based on patterns learned from PRs, issues, and user interactions.

Core Features & Use Cases

  • Read and update Cursor rule files (.cursor/rules/*.mdc) by parsing frontmatter and sections.
  • Create new rules for emerging patterns and link them to related rules and PRs/issues.
  • Validate and test rule effectiveness, ensuring organized and consistent rule documentation.

Quick Start

Run the updater to examine an existing rule, generate proposed updates, or create new rules based on observed patterns in PRs and issues. Example: python -m rule_updater --read .cursor/rules/common-mistakes.mdc

Frequently Asked Questions about rule-updater

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update Cursor rules based on PR patterns?

You can update Cursor rules by programmatically reading and modifying .mdc files, parsing frontmatter and sections to align rule content with observed PR patterns and user interactions. This ensures rule documentation stays organized and consistent.

What is the best way to automate Cursor rule maintenance?

Automating Cursor rule maintenance involves programmatically reading, updating, and creating .mdc files based on evolving patterns. The updater evaluates rule effectiveness and links new rules to related PRs and issues for traceable references.

Can I create new Cursor rules from emerging repository patterns?

Yes, you can create new Cursor rules for emerging patterns by analyzing interactions and issues. The updater generates new rule files, links them to related existing rules, and ensures the overall rule structure remains validated.

How does parsing frontmatter work for Cursor rules?

Parsing frontmatter for Cursor rules involves reading .mdc files to understand rule structures and metadata. This mechanism allows the updater to evaluate rule effectiveness and accurately update existing content as patterns evolve.

Do I need existing .mdc files to use a Cursor rule updater?

You do not strictly need existing .mdc files, as the updater can create new rules for emerging patterns. However, having existing rules allows the tool to parse frontmatter, evaluate effectiveness, and link related rules together.