| Name | ide-rules JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A tool to manage IDE rules files for Windsurf and Cursor |
| upload_time | 2025-09-07 00:58:41 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT |
| keywords |
cursor
development
ide
rules
windsurf
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# IDE Rules Manager
A tool to manage IDE rules files for Windsurf and Cursor.
## Installation
Install directly from GitHub using uvx:
```bash
uvx run github.com/yourusername/ide-rules --help
```
## Usage
### Copy rules to an IDE
```bash
# 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
```bash
# 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
```bash
# 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
Raw data
{
"_id": null,
"home_page": null,
"name": "ide-rules",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "cursor, development, ide, rules, windsurf",
"author": null,
"author_email": "Your Name <you@example.com>",
"download_url": "https://files.pythonhosted.org/packages/66/5a/db242e493e4d8c6120df7069774bed6e58071a48b7ed0938987275cb7113/ide_rules-0.1.0.tar.gz",
"platform": null,
"description": "# IDE Rules Manager\n\nA tool to manage IDE rules files for Windsurf and Cursor.\n\n## Installation\n\nInstall directly from GitHub using uvx:\n\n```bash\nuvx run github.com/yourusername/ide-rules --help\n```\n\n## Usage\n\n### Copy rules to an IDE\n\n```bash\n# Copy to Windsurf in current directory\nide-rules copy --ide windsurf\n\n# Copy to Cursor in a specific directory\nide-rules copy --ide cursor --target /path/to/project\n\n# Dry run to see what would be copied\nide-rules copy --dry-run\n\n# Force overwrite existing files\nide-rules copy --force\n```\n\n### List existing rules\n\n```bash\n# List Windsurf rules in current directory\nide-rules list-rules --ide windsurf\n\n# List Cursor rules in specific directory\nide-rules list-rules --ide cursor --target /path/to/project\n```\n\n### Clean up rules\n\n```bash\n# Remove all Windsurf rules (dry run first)\nide-rules clean --ide windsurf --dry-run\nide-rules clean --ide windsurf\n```\n\n## Features\n\n- Supports both Windsurf and Cursor IDEs\n- Automatically transforms file extensions (.mdc \u2194 .md) based on IDE\n- Includes a comprehensive set of development rules\n- Dry run mode to preview changes\n- Force mode to overwrite existing files\n\n## Rules Included\n\n- Domain terminology and naming conventions\n- FastAPI deployment patterns\n- Makefile development patterns\n- Polars data processing best practices\n- Prompt engineering patterns\n- Python testing with pytest\n- Python coding style guidelines\n- Script organization patterns\n- Typer CLI development\n- UV Python package management",
"bugtrack_url": null,
"license": "MIT",
"summary": "A tool to manage IDE rules files for Windsurf and Cursor",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/yourusername/ide-rules",
"Issues": "https://github.com/yourusername/ide-rules/issues",
"Repository": "https://github.com/yourusername/ide-rules"
},
"split_keywords": [
"cursor",
" development",
" ide",
" rules",
" windsurf"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "27ce7f422b7fbfd02f626456f627eb9c92319624c3da0daa56964a7fc4316bed",
"md5": "239af8b59ada13791edf89d3fc3d3db7",
"sha256": "7e9c8ee9e38d21a4ac2065cf6a577e6e0857baad2b4371f5f1b848895b03a2b7"
},
"downloads": -1,
"filename": "ide_rules-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "239af8b59ada13791edf89d3fc3d3db7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 28248,
"upload_time": "2025-09-07T00:58:40",
"upload_time_iso_8601": "2025-09-07T00:58:40.286644Z",
"url": "https://files.pythonhosted.org/packages/27/ce/7f422b7fbfd02f626456f627eb9c92319624c3da0daa56964a7fc4316bed/ide_rules-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "665adb242e493e4d8c6120df7069774bed6e58071a48b7ed0938987275cb7113",
"md5": "a49d068266318a6151482020079b3d02",
"sha256": "52cd2d30f2ec59f39e381592becbd5da5a1b2b18ac673312be7cd5027bbf1699"
},
"downloads": -1,
"filename": "ide_rules-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "a49d068266318a6151482020079b3d02",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 28404,
"upload_time": "2025-09-07T00:58:41",
"upload_time_iso_8601": "2025-09-07T00:58:41.653329Z",
"url": "https://files.pythonhosted.org/packages/66/5a/db242e493e4d8c6120df7069774bed6e58071a48b7ed0938987275cb7113/ide_rules-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-07 00:58:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yourusername",
"github_project": "ide-rules",
"github_not_found": true,
"lcname": "ide-rules"
}
