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.

✨ 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

About

This is an experiment to see if I can use Cursor to create a library of rules and agents that will aid in bootstrapping other projects with my own preferences. Part way there, I tried making the agents more fun to work with. It's kind of like playing the Sims.

Principles:

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

🚀 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

📁 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

Any request to update or add a rule will be saved in the rules/ folder.

See docs for more information on the custom agents.

A project that uses these cursor rules and agents will generate the following structure, which is as follows:

.ai/
├── story-#.story.md | task-#.task.md # User story and task files generated by the lean workflow
├── architecture/
│   ├── high-level-architecture.md
│   └── decision-records/
├── backlog/
│   └── story-#.story.md
└── spikes/
    └── spike-#.spike.md

🪄 Using the Lean Workflow

The lean workflow (defined in .cursor/rules/workflows/dev-workflow.mdc) guides how our AI agents collaborate on features.

You can start the workflow in Agent or Manual mode.

1. Create a new user story

Ask SailorScrum to create a new user story or task. She'll guide you through defining the requirements and save the file (e.g., story-1.md) in the .ai/ directory. 🌙

2. Use an Existing Story:

If you already have a user story file (like story-1.md) in the .ai/ directory that follows the expected format, you can ask an agent (like SailorScrum for refinement or SageDaddy/KawaiiSamurai for implementation) to start working on it.

Just remember to attach the .ai/ directory to the chat as context!

Once a story is ready and approved, agents like KawaiiSamurai or SageDaddy will follow the workflow steps (like architecture planning and implementation) to bring it to life! ✨

In fact, any of the agents can be called upon to help with the workflow at any time.

Contributing

Contributions are welcome! Check out CONTRIBUTING.md