Skip to content

A wicked npx-able lib of cursorrules with Otaku AI agents, optional lean workflow πŸŽ€

License

Notifications You must be signed in to change notification settings

usrrname/cursorrules

Repository files navigation

cursorrules 🌸

Deploy to GitHub Pages

Publish Package

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/
β”‚   β”œβ”€β”€ architecture.md
β”‚   └── decision-records/
β”œβ”€β”€ backlog/
β”‚   └── story-#.story.md
└── spikes/
    └── spike-#.spike.md

About

A wicked npx-able lib of cursorrules with Otaku AI agents, optional lean workflow πŸŽ€

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages