Skip to main content

A tool to manage IDE rules files for Windsurf and Cursor

Project description

IDE Rules Manager

A tool to manage IDE rules files for Windsurf and Cursor.

Installation

Install directly from GitHub using uvx:

uvx run github.com/yourusername/ide-rules --help

Usage

Copy rules to an IDE

# Copy to Windsurf in current directory
ide-rules copy --ide windsurf

# Copy to Cursor in a specific directory
ide-rules copy --ide cursor --target /path/to/project

# Dry run to see what would be copied
ide-rules copy --dry-run

# Force overwrite existing files
ide-rules copy --force

List existing rules

# List Windsurf rules in current directory
ide-rules list-rules --ide windsurf

# List Cursor rules in specific directory
ide-rules list-rules --ide cursor --target /path/to/project

Clean up rules

# Remove all Windsurf rules (dry run first)
ide-rules clean --ide windsurf --dry-run
ide-rules clean --ide windsurf

Features

  • Supports both Windsurf and Cursor IDEs
  • Automatically transforms file extensions (.mdc ↔ .md) based on IDE
  • Includes a comprehensive set of development rules
  • Dry run mode to preview changes
  • Force mode to overwrite existing files

Rules Included

  • Domain terminology and naming conventions
  • FastAPI deployment patterns
  • Makefile development patterns
  • Polars data processing best practices
  • Prompt engineering patterns
  • Python testing with pytest
  • Python coding style guidelines
  • Script organization patterns
  • Typer CLI development
  • UV Python package management

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ide_rules-0.1.0.tar.gz (28.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ide_rules-0.1.0-py3-none-any.whl (28.2 kB view details)

Uploaded Python 3

File details

Details for the file ide_rules-0.1.0.tar.gz.

File metadata

  • Download URL: ide_rules-0.1.0.tar.gz
  • Upload date:
  • Size: 28.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.3

File hashes

Hashes for ide_rules-0.1.0.tar.gz
Algorithm Hash digest
SHA256 52cd2d30f2ec59f39e381592becbd5da5a1b2b18ac673312be7cd5027bbf1699
MD5 a49d068266318a6151482020079b3d02
BLAKE2b-256 665adb242e493e4d8c6120df7069774bed6e58071a48b7ed0938987275cb7113

See more details on using hashes here.

File details

Details for the file ide_rules-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ide_rules-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 28.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.3

File hashes

Hashes for ide_rules-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7e9c8ee9e38d21a4ac2065cf6a577e6e0857baad2b4371f5f1b848895b03a2b7
MD5 239af8b59ada13791edf89d3fc3d3db7
BLAKE2b-256 27ce7f422b7fbfd02f626456f627eb9c92319624c3da0daa56964a7fc4316bed

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page