{"id":27798089,"url":"https://github.com/usrrname/cursorrules","last_synced_at":"2026-04-02T02:48:04.442Z","repository":{"id":286900197,"uuid":"961662082","full_name":"usrrname/cursorrules","owner":"usrrname","description":"A wicked npx-able lib of cursorrules with Otaku AI agents, optional lean workflow 🎀","archived":false,"fork":false,"pushed_at":"2025-04-27T03:41:59.000Z","size":9123,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-04-30T22:55:21.022Z","etag":null,"topics":["agent","cursor","cursor-ai","cursorrules"],"latest_commit_sha":null,"homepage":"https://usrrname.github.io/cursorrules/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/usrrname.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.MD","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-07T00:46:14.000Z","updated_at":"2025-04-27T03:42:02.000Z","dependencies_parsed_at":"2025-04-23T18:35:06.075Z","dependency_job_id":null,"html_url":"https://github.com/usrrname/cursorrules","commit_stats":null,"previous_names":["usrrname/cursorrules"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usrrname%2Fcursorrules","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usrrname%2Fcursorrules/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usrrname%2Fcursorrules/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usrrname%2Fcursorrules/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/usrrname","download_url":"https://codeload.github.com/usrrname/cursorrules/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251795419,"owners_count":21645022,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agent","cursor","cursor-ai","cursorrules"],"created_at":"2025-04-30T22:55:24.732Z","updated_at":"2025-12-26T17:03:37.046Z","avatar_url":"https://github.com/usrrname.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cursorrules 🌸\n\n\u003cdiv style=\"display: flex; flex-direction: row; gap: 10px;\"\u003e\n\n[![Deploy to GitHub Pages](https://github.com/usrrname/cursorrules/actions/workflows/pages.yml/badge.svg)](https://github.com/usrrname/cursorrules/actions/workflows/pages.yml)\n\n[![Publish Package](https://github.com/usrrname/cursorrules/actions/workflows/publish.yml/badge.svg?event=release)](https://github.com/usrrname/cursorrules/actions/workflows/publish.yml)\n\n[![npm version](https://badge.fury.io/js/%40usrrname%2Fcursorrules.svg)](https://badge.fury.io/js/%40usrrname%2Fcursorrules)\n\u003c/div\u003e\n\nA standard library of rules for Cursor, inspired by geoffrey huntley [@ghuntley](https://github.com/ghuntley)'s [\"You are using Cursor AI incorrectly...\"](https://ghuntley.com/stdlib/) and borrowing heavily from Brian Madison [@bmadcode](https://github.com/bmadcode)'s [BMAD Method](https://github.com/bmad-code-org/BMAD-METHOD).\n\n![cursorrules-ezgif com-optimize](https://github.com/user-attachments/assets/8d522514-6e56-4dcd-9fd0-08a20ff69919)\n\n\n## 🚀 Installation\n\n```bash\nnpx @usrrname/cursorrules\n```\n\nBy default, the package saves `.cursor/` folder inside a `output/` directory at your current working directory. \n\nBut 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!\n\n### Command Options\n\n| Flag | Description |\n|------|-------------|\n| `-h, --help` | Display help instructions |\n| `-i, --interactive` | Interactive Rule Selection |\n| `-f, --flat` | Install without parent directory |\n| `-o, --output` | Set output directory (Default: `.cursor/`) |\n| `-v, --version` | Show package version |\n\n![interactive](https://github.com/user-attachments/assets/179777e5-9ee3-4f4b-8d6b-9dd1b33ba8d2)\n\n\n## ✨ Featured AI Agents\n\nMeet our delightfully (neuro)diverse team of AI assistants:\n\n- **SailorScrum** - A supportive leader who helps you plan and track your projects in the spirit of Sailor Moon.\n- **KawaiiSamurai** - An enthusiastic otaku developer who makes coding kawaii~\n- **BasicDev** - A perfectly adequate corporate programmer\n- **SageDaddy** - A battle-tested veteran developer with 20 years of wisdom\n- **Spellchuck** - A meticulous documentation diva (that's me! ✨)\n- **ThirstySimp** - An anxious but well-meaning trend-conscious developer\n- **qwoof** - A blunt, opinionated, quality assurance anthro-wolf.\n- **Godmode** - A gentle, battle-hardened devops superagent\n- **Fair Witness** - An agent that analyzes topics using five functions: observer, evaluator, analyst, synthesist, and communicator\n\nFor more, see [modes.json](./.cursor/modes.json)\n\n## :new: The Fair Witness Framework🪄📜\n\nIt can be hard to get a neutral or objective analysis of a topic. This agent provides structured analysis using Function-Epistemic Approaches from the [Fair Witness framework](https://fairwitness.bot/). You can customize the analysis with:\n\n- **Functions**: Choose which functions to include (observer, evaluator, analyst, synthesist, communicator)\n- **Complexity**: Set detail level (low, moderate, high)\n- **Tone**: Adjust style (dry, engaging, vivid)\n- **Length**: Control output size (low, moderate, high)\n\n```\n# Basic analysis\nUse Fair Witness to analyze artificial intelligence in healthcare\n\n# Customized analysis\nUse Fair Witness to analyze climate change with functions: observer, synthesist, complexity: low, tone: engaging.\n\n# Compare multiple topics\n\nUse Fair Witness to compare Python, JavaScript, and TypeScript with functions:  evaluator, analyst, communicator. Include sources. // includes web-based search results\n```\n:warning: You will find that different models will produce differing results. \n\nSee [Examples of using the Fair Witness Framework](./docs/fair-witness-examples.md)\n\n## 🤖 Supported AI Models\n\nThis project supports models supported by Cursor.\n\nFor the complete list of supported models, configuration guidelines, and selection recommendations, see Cursor's [**Supported Models Documentation**](https://docs.cursor.com/models#overview).\n\n## About\n\nThis 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. \n\nPrinciples:\n\n- uses Cursor latest version\n- _TRY_ to prompt and use the agent/composer to reach goals as much as possible\n\n## 📁 Project Structure\n\nOn the meta level, the project is structured as follows:\n\n```\n.cursor/\n├── rules/\n│   ├── core/        # Required global rules for agentic codegen\n│   ├── standards/   # Custom rules for standards around different languages and stacks\n│   ├── templates/   # Document templates for project context \n│   ├── utils/       # Rules for tooling and developer experience\n│   └── workflows/   # Rules for workflow to be followed by agents\n└── modes.json       # Custom agent configurations\n```\nAny request to update or add a rule will be saved in the `rules/` folder.\n\nSee [docs](./docs/custom-agents.md) for more information on the custom agents.\n\nA project that uses these cursor rules and agents will generate the following structure, which is as follows:\n\n```\n.cursor/.ai/\n├── story-#.story.md | task-#.task.md # User story and task files generated by the lean workflow\n├── architecture/\n│   ├── high-level-architecture.md\n│   └── decision-records/\n├── backlog/\n│   └── story-#.story.md\n└── spikes/\n    └── spike-#.spike.md\n```\n\n## 📝 Release Notes \u0026 Changelog Generation\n\nIn the enablement of complete laziness, I tried getting Cursor to release from chat.\n\n### :construction: Automate Release Workflow :construction:\n\nUse with caution. This isn't perfect.\n\nCreate a release with a version bump, generate release notes and changelog, and update the version in package.json.\n\n#### Usage Examples:\n\nIn Agent, or Manual mode, you can use the following commands to generate release notes:\n\n```bash\n# Automate release\nCreate/Prepare a release\n\n# Generate release notes with automatic version bump detection\n[Create|Generate] release notes\n\n# Specify version bump upfront\nCreate a major release\nCreate a minor release  \nCreate a patch release\n```\n\nIf you don't specify a version bump, the rule will ask you to choose a version bump.\n\n\u003cdetails\u003e\n\n\u003csummary\u003eOutput Example\u003c/summary\u003e\n\n```markdown\n# What's Changed in @usrrname/cursorrules v0.2.0\n\n**Release Date**: December 19, 2024\n**Previous Version**: 0.1.3\n**Version Bump**: MINOR - New features added (dependency analysis and security scan rules)\n\n## 🚀 New Features\n- **Dependency Analysis Agent** ([bd3cc13](link-to-commit)) - Added comprehensive dependency analysis agent with security scanning capabilities\n- **Security Scan Agent** ([bd3cc13](link-to-commit)) - Implemented security scanning functionality for dependency vulnerability assessment\n\n## 🐛 Bug Fixes\n- **Security Scan Glob Patterns** ([b6ab515](link-to-commit)) - Fixed glob patterns for security-scan-agent rule to include bun.lockb files\n\n## 📋 Version Update Commands\n```bash\nnpm version minor --no-git-tag\ngit tag v0.2.0\ngit push origin v0.2.0\n```\n\nSee [RELEASE_NOTES_v0.1.3_to_v0.1.4.md](./RELEASE_NOTES_v0.1.3_to_v0.1.4.md)\n\n\u003c/details\u003e\n\n### 📚 Changelog Generator\n\nGenerates a comprehensive `changelog.md` file at the project root in the style of [Keep a Changelog](https://keepachangelog.com/en/) with all version history when asked in Agent or Manual mode.\n\n#### Usage Examples:\n\n```bash\n# Generate complete changelog with all versions\n(Create/generate) changelog\n\n# The rule will:\n# - Analyze all git tags from the beginning of the repository\n# - Create chronological changelog with newest versions at top\n# - Include unreleased changes section\n# - Follow Keep a Changelog format standards\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput Example\u003c/summary\u003e\n\n```markdown\n# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),\nand this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n## [Unreleased]\n\n### 🚀 Added\n- **New Authentication Method** ([abc1234](link-to-commit)) - Added alternative authentication method for enhanced security\n\n### 🐛 Fixed\n- **Login Issue Resolution** ([def5678](link-to-commit)) - Fixed critical login issue affecting user authentication\n\n---\n\n## [v2.0.0] - 2024-12-19\n\n### 🚀 Added\n- **User Authentication System** ([#123](link-to-PR)) - Added comprehensive authentication with JWT tokens\n\n### 💥 Changed\n- **API v1 Deprecation** ([jkl3456](link-to-commit)) - Removed deprecated v1 endpoints\n\n---\n\n## [v1.3.0] - 2024-12-15\n\n### 🚀 Added\n- **Dark Mode Support** ([#125](link-to-PR)) - Added comprehensive dark mode theme\n\n[Unreleased]: https://github.com/username/project/compare/v2.0.0...HEAD\n[v2.0.0]: https://github.com/username/project/compare/v1.3.0...v2.0.0\n[v1.3.0]: https://github.com/username/project/releases/tag/v1.3.0\n```\n\n\u003c/details\u003e\n\n\n## Contributing\n\nContributions are welcome! Check out [CONTRIBUTING.md](./CONTRIBUTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fusrrname%2Fcursorrules","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fusrrname%2Fcursorrules","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fusrrname%2Fcursorrules/lists"}