@gabimoncha/cursor-rules
Version:
A CLI for bootstrapping Cursor rules to a project
50 lines (33 loc) • 1.35 kB
Markdown
This file contains the entire codebase of library. Create or edit the current `.cursor/rules/project-structure.mdc` rules, to include the project's main purpose, key features, directory structure and overall architecture. Use `directory_structure` from this file, to create a formatted tree structure of the project, with a short description for each folder.
Example PROJECT_STRUCTURE.md output:
```markdown
description: Project structure and file organization guidelines
globs:
alwaysApply: false
# Project name
Short description of the project
## Purpose
The purpose of the project
## Key features
- Feature 1: do something
- Feature 2: do something else
## Directory structure
```tree
.
├── parent_folder/ # this is the parent_folder description
│ ├── child_folder/ # this is the child_folder description
│ └── other_child_folder/ # this is the other_child_folder description
└── single_folder/ # this is the single folder description
```
## Usage
Run command
## Technical implementation
The project is built with:
- TypeScript: for type-safe code
## Future Enhancements
- Add support for feature 3
- Enhance feature 2
```
After editing the file, tell the user he might need to refresh the Explorer or restart Cursor to see the applied changes.