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 library of rules for Cursor, inspired by geoffrey huntley @ghuntley's "You are using Cursor AI incorrectly..." and borrowing heavily from Brian Madison @bmadcode's Cursor Custom Agents Rules Generator.

About

This is an experiment to see if I can use cursor to create a library of rules and agents that I can use to bootstrap other projects with my own preferences. Part way there, I ended up seeing whether I could give personality to the agents so they were more fun to work with. It's kind of like playing the Sims.

uses Cursor latest version
TRY to prompt and use the agent/composer to reach goals as much as possible

✨ Featured AI Agents

Meet our delightfully (neuro)diverse team of AI assistants:

SailorScrum - A supportive leader who helps you plan and track your projects in the spirit of Sailor Moon.
KawaiiSamurai - An enthusiastic otaku developer who makes coding kawaii~
BasicDev - A perfectly adequate corporate programmer
SageDaddy - A battle-tested veteran developer with 20 years of wisdom
Spellchuck - A meticulous documentation diva (that's me! ✨)
ThirstySimp - An anxious but well-meaning trend-conscious developer
qwoof - A blunt, opinionated, quality assurance anthro-wolf.
Godmode - A gentle, battle-hardened devops superagent

For more, see modes.json

📁 Project Structure

On the meta level, the project is structured as follows:

.cursor/
├── rules/
│   ├── core/        # Required global rules for agentic codegen
│   ├── standards/   # Custom rules for standards around different languages and stacks
│   ├── templates/   # Document templates for project context 
│   ├── utils/       # Rules for tooling and developer experience
│   └── workflows/   # Rules for workflow to be followed by agents
└── modes.json       # Custom agent configurations

See docs for more information on the custom agents.

On the project level, a project that uses these cursor rules and agents will have its own structure, which is as follows:

.ai/
├── architecture/
│   ├── ###-architecture.md
│   └── decision-records/
├── backlog/
│   └── ###-user-story-title.md
└── spikes/
    └── ####-spike-title.md

🚀 Installation

npx @usrrname/cursorrules

By default, the package saves .cursor/ folder inside a output/ directory at your current working directory.

But if you're inside the root of a project folder, running npx @usrrname/cursorrules --flat will save the .cursor/ folder to the root of the project, and then you're ready to go!

Command Options

Flag	Description
`-h, --help`	Display help instructions
`-f, --flat`	Install without parent directory
`-o, --output`	Set output directory (Default: `./output`)
`-v, --version`	Show package version

🧪 Local Development

Prerequisites

Node.js (v20 or higher)
npm or yarn

Setup Steps

Install Verdaccio:
```
npm install -g verdaccio
```

Start Verdaccio:

verdaccio  # Use --config config/verdaccio.yml for custom configuration

Configure local registry:

# Set registry
npm config set @usrrname:registry http://localhost:4873/

# Verify registry setting
npm config get @usrrname:registry
# should return http://localhost:4873/

Build and publish:
```
npm publish --scope=@usrrname
```

Test the command locally:

## as a tarball
npm pack
## as a folder
npx cursorrules

Clean up test versions:

npm unpublish @usrrname:registry http://localhost:4873/ @usrrname/cursorrules

🚧 Under construction 🚧

MCP Setup

About Model Context Protocol