Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@usrrname/cursorrules) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

cursorrules

A standard lib of rules for Cursor inspired by @ghuntley's "You are using Cursor AI incorrectly..." and @bmadcode's Cursor Custom Agents Rules Generator

Folder structure

The project is organized into the following folders:

.cursor
└── rules
    ├── core        required global rules for agentic codegen
    ├── templates   document templates for project context 
    └── utils       rules about tooling and config that improve devex

Install

npx @usrrname/cursorrules

By default, the package will save files to output/ in your current directory.

Options

-h, --help: Help instructions
-f, --flat: Install without parent directory
-o, --output: Set output directory # Default: ./output
-v, --version: Show package version

Running and testing locally

Install Verdaccio

npm install -g verdaccio

Run Verdaccio

verdaccio # --config config/verdaccio.yml to use the one in this repo

Set registry to local Verdaccio

npm config set registry http://localhost:4873/ --scope=@usrrname
npm set registry http://localhost:4873/ --scope=@usrrname

Build and publish

npm publish --registry http://localhost:4873/

npx @usrrname/cursorrules

Remove test versions

npm unpublish --registry http://localhost:4873/ cursorrules