noah-cursor 1.5.2 → 1.5.4

package/README.md

@@ -2,40 +2,131 @@
   <img src="https://cdn.jsdelivr.net/npm/noah-cursor@latest/assets/noah-cursor-banner.png" alt="Noah Cursor" width="100%" />
 </p>
 
-Install Noah's reusable Cursor assets — Skills, Rules, Prompts, MCP configs, and Presets — into your project.
+<p align="center">
+  <strong>The CLI for shipping Cursor setups that actually work.</strong><br />
+  Install battle-tested Skills, Rules, and workflows into any project — in one command.
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/noah-cursor"><img src="https://img.shields.io/npm/v/noah-cursor.svg" alt="npm version" /></a>
+  <a href="https://www.npmjs.com/package/noah-cursor"><img src="https://img.shields.io/npm/dm/noah-cursor.svg" alt="npm downloads" /></a>
+  <a href="LICENSE"><img src="https://img.shields.io/npm/l/noah-cursor.svg" alt="license" /></a>
+  <img src="https://img.shields.io/node/v/noah-cursor.svg" alt="node" />
+  <a href="https://www.buymeacoffee.com/itsmenoahpoli"><img src="https://img.shields.io/badge/Buy%20Me%20a%20Coffee-FFDD00?style=flat&logo=buymeacoffee&logoColor=black" alt="Buy Me a Coffee" /></a>
+</p>
 
 ```bash
-npx noah-cursor add --skill test
+npx noah-cursor add --skill commit-push
 ```
 
-## Install
+Stop copy-pasting Cursor prompts between repos. **Noah Cursor** is a developer CLI + curated registry: reusable Skills, Rules, Prompts, MCP configs, and Presets that drop straight into `.cursor/` — no clone, no sign-in, no friction.
+
+## Built for your stack
+
+<p align="center">
+  <img src="https://skillicons.dev/icons?i=nodejs,typescript,react,nextjs,vue,nuxtjs,nestjs,laravel,php,git&perline=10" alt="Tech stack" />
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/Cursor-000000?style=flat-square&logo=cursor&logoColor=white" alt="Cursor" />
+  <img src="https://img.shields.io/badge/Node.js-339933?style=flat-square&logo=nodedotjs&logoColor=white" alt="Node.js" />
+  <img src="https://img.shields.io/badge/TypeScript-3178C6?style=flat-square&logo=typescript&logoColor=white" alt="TypeScript" />
+  <img src="https://img.shields.io/badge/React-61DAFB?style=flat-square&logo=react&logoColor=black" alt="React" />
+  <img src="https://img.shields.io/badge/Next.js-000000?style=flat-square&logo=nextdotjs&logoColor=white" alt="Next.js" />
+  <img src="https://img.shields.io/badge/Nuxt-00DC82?style=flat-square&logo=nuxt&logoColor=black" alt="Nuxt" />
+  <img src="https://img.shields.io/badge/NestJS-E0234E?style=flat-square&logo=nestjs&logoColor=white" alt="NestJS" />
+  <img src="https://img.shields.io/badge/Laravel-FF2D20?style=flat-square&logo=laravel&logoColor=white" alt="Laravel" />
+</p>
+
+Curated Skills & Rules for the stacks you already ship — React dashboards, Laravel APIs, Next/Nuxt marketing sites, NestJS, and Node.
+
+## Why developers use it
+
+| Pain | Noah Cursor |
+| ---- | ----------- |
+| Rebuilding the same Cursor setup on every project | One command installs a full workflow |
+| Vague AI prompts that drift between teammates | Versioned Skills & Rules from a real registry |
+| Hunting docs every time you switch stacks | Stack-specific rules for React, Laravel, Next, Nuxt |
+| Manual QA loops with lint/doctor tools | Fix Skills that run → fix → verify |
+
+Built for people who live in the terminal and want Cursor to feel like a product, not a blank slate.
+
+## Demo
+
+<p align="center">
+  <img src="https://cdn.jsdelivr.net/gh/itsmenoahpoli/noah-cursor@main/demos/noah-cursor.gif" alt="Noah Cursor CLI demo" width="100%" />
+</p>
+
+## Quick start
+
+Requires **Node.js 20+**.
 
 ```bash
-# One-shot (recommended) — uses the registry bundled in the package
-npx noah-cursor add --skill <name>
+# Try it instantly — no global install
+npx noah-cursor browse
 
-# Or install globally
+# Or install once
 npm install -g noah-cursor
+noah-cursor browse
 ```
 
-Requires **Node.js 20+**. The registry ships inside the package (no GitHub clone or sign-in).
+The registry ships inside the package. Nothing to clone. Nothing to authenticate.
+
+### 30-second wins
+
+```bash
+# Ship cleaner commits every time
+npx noah-cursor add --skill commit-push
+
+# Auto-generate a solid project README
+npx noah-cursor add --skill generate-readme
+
+# React health pass: run doctor → fix → verify
+npx noah-cursor add --skill react-doctor-fix
+
+# Stack rules for a Laravel API + React dashboard
+npx noah-cursor add --rule laravel-api --rule react-spa-dashboard
+```
+
+## What you get
+
+### Skills — agent workflows you can reuse
+
+| Skill | What it does |
+| ----- | ------------ |
+| <img src="https://skillicons.dev/icons?i=git" alt="Git" width="20" height="20" /> `commit-push` | Stage, group by category, draft a clean commit, push |
+| <img src="https://skillicons.dev/icons?i=md" alt="Docs" width="20" height="20" /> `generate-readme` | Generate README with stack, deps, prerequisites, setup |
+| <img src="https://skillicons.dev/icons?i=react" alt="React" width="20" height="20" /> `react-doctor-fix` | Run react-doctor, fix findings, verify no regressions |
+| <img src="https://skillicons.dev/icons?i=laravel" alt="Laravel" width="20" height="20" /> `larastan-fix` | Run Larastan on Laravel, fix, verify |
+| <img src="https://skillicons.dev/icons?i=nestjs" alt="NestJS" width="20" height="20" /> `nestjs-knip-fix` | Knip on NestJS — unused code/deps out, features intact |
+| <img src="https://skillicons.dev/icons?i=nodejs" alt="Node.js" width="20" height="20" /> `node-doctor-fix` | Bundled node-doctor (Knip + hygiene) for generic Node |
+
+### Rules — stack guidance baked into Cursor
+
+| Rule | For |
+| ---- | --- |
+| <img src="https://skillicons.dev/icons?i=react,laravel,nextjs,nuxtjs" alt="Stacks" height="20" /> `stack-architecture` | Choosing React SPA vs Laravel API vs Next/Nuxt marketing |
+| <img src="https://skillicons.dev/icons?i=react" alt="React" width="20" height="20" /> `react-spa-dashboard` | React + TypeScript + TanStack Query dashboards |
+| <img src="https://skillicons.dev/icons?i=laravel" alt="Laravel" width="20" height="20" /> `laravel-api` | Headless Laravel APIs (Sanctum-ready) |
+| <img src="https://skillicons.dev/icons?i=nextjs" alt="Next.js" width="20" height="20" /> `nextjs-marketing` | Next.js App Router marketing / branding sites |
+| <img src="https://skillicons.dev/icons?i=nuxtjs" alt="Nuxt" width="20" height="20" /> `nuxt-marketing` | Nuxt 3+ marketing / branding sites |
+
+Prompts, MCP configs, and Presets are supported by the CLI — more shipping soon.
 
 ## Commands
 
-| Command  | Description                             |
-| -------- | --------------------------------------- |
-| `add`    | Install assets from Noah's registry     |
-| `browse` | Interactively browse and install assets |
-| `search` | Search assets in Noah's registry        |
-| `list`   | List all assets in Noah's registry      |
-| `remove` | Remove an installed asset               |
-| `update` | Re-fetch and update installed assets    |
-| `doctor` | Diagnose environment health             |
+| Command | Description |
+| ------- | ----------- |
+| `browse` | Interactive TUI — discover & install without memorizing ids |
+| `add` | Install Skills, Rules, Prompts, MCP, or Presets |
+| `search` | Search the registry |
+| `list` | List registry or installed assets |
+| `remove` | Uninstall an asset |
+| `update` | Re-fetch and update installed assets |
+| `doctor` | Diagnose environment health |
 
 ### browse
 
-Interactive TUI for discovering assets without knowing their ids:
-
 ```bash
 noah-cursor browse
 noah-cursor browse --browse-skills
@@ -45,18 +136,12 @@ noah-cursor browse --browse-mcp
 noah-cursor browse --browse-presets
 ```
 
-```bash
-npx noah-cursor browse
-npx noah-cursor browse --browse-skills
-```
-
 Controls: ↑↓ navigate · Space select · A toggle all · I invert · Enter confirm · Esc cancel
 
 ### add
 
 ```bash
 noah-cursor add
-
   --skill <name>
   --rule <name>
   --prompt <name>
@@ -69,21 +154,18 @@ noah-cursor add
   --verbose
 ```
 
-Always installs from **Noah's bundled registry** (no other registries).
-
-Examples:
+Always installs from **Noah's bundled registry**.
 
 ```bash
-npx noah-cursor add --skill test
-npx noah-cursor add --rule test
-npx noah-cursor add --all
 npx noah-cursor add --skill commit-push
+npx noah-cursor add --rule nextjs-marketing
+npx noah-cursor add --all
 ```
 
 ### search / list / remove / update / doctor
 
 ```bash
-noah-cursor search test
+noah-cursor search doctor
 noah-cursor list
 noah-cursor list --installed
 noah-cursor remove skill test --yes
@@ -91,7 +173,22 @@ noah-cursor update --yes
 noah-cursor doctor
 ```
 
-## Registry specification
+## How it works
+
+Assets land in your project under `.cursor/`:
+
+```
+.cursor/
+  skills/
+  rules/
+  prompts/
+  mcp/
+  noah.json          # tracks what you installed
+```
+
+`noah.json` keeps versions and registry metadata so `update` and `remove` stay reliable across machines and teammates.
+
+## Build your own registry assets
 
 This repo is both the **CLI** and the **registry**. At the project root:
 
@@ -104,19 +201,7 @@ mcp/
 presets/
 ```
 
-### Starter assets
-
-- **skill** `test`
-- **skill** `commit-push`
-- **skill** `react-doctor-fix` — run react-doctor, fix findings, verify no regressions
-- **skill** `larastan-fix` — run Larastan on Laravel, fix findings, verify no regressions
-- **skill** `nestjs-knip-fix` — run Knip on NestJS, fix unused code/deps, verify no regressions
-- **skill** `node-doctor-fix` — bundled node-doctor (Knip + package hygiene) for generic Node
-- **rule** `test`
-
-Add curated Noah assets under those folders and register them in `manifest.json`. Presets are supported by the CLI but none are published in this registry yet.
-
-### manifest.json
+Add an asset folder, register it in `manifest.json`, ship. Each `id` maps to a folder under the matching directory (or set an explicit `path`).
 
 ```json
 {
@@ -125,66 +210,60 @@ Add curated Noah assets under those folders and register them in `manifest.json`
   "description": "My Cursor assets",
   "skills": [
     {
-      "id": "test",
+      "id": "my-workflow",
       "version": "1.0.0",
-      "description": "Sample skill",
-      "tags": ["test"]
-    }
-  ],
-  "rules": [
-    {
-      "id": "test",
-      "version": "1.0.0",
-      "description": "Sample rule"
+      "description": "What this skill does",
+      "tags": ["git"]
     }
   ],
+  "rules": [],
   "prompts": [],
   "mcp": [],
   "presets": []
 }
 ```
 
-Each asset `id` maps to a folder under the matching directory (e.g. `skills/test/`), unless an explicit `path` is set.
-
-## Installation targets
-
-Assets are copied into your project:
-
-```
-.cursor/
-  skills/
-  rules/
-  prompts/
-  mcp/
-  noah.json
-```
-
-### .cursor/noah.json
-
-```json
-{
-  "registry": "https://github.com/itsmenoahpoli/noah-cursor",
-  "installed": [
-    {
-      "type": "skill",
-      "id": "test",
-      "version": "1.0.0"
-    }
-  ]
-}
-```
-
 ## Development
 
 ```bash
 npm install
-npm run build   # compiles TypeScript and bundles registry → dist/registry
+npm run build   # TypeScript + bundle registry → dist
 npm test
 npm run dev -- doctor
 ```
 
-`npm run build` copies `manifest.json` plus `skills/`, `rules/`, `prompts/`, `mcp/`, and `presets/` into `dist/noah-registry/` so published installs never need to clone GitHub.
+`npm run build` copies `manifest.json` plus `skills/`, `rules/`, `prompts/`, `mcp/`, and `presets/` into `dist/noah-registry/` so published installs never need GitHub access.
+
+## Contributing
+
+Ideas for Skills, Rules, or MCP configs? Open an issue or PR. The best assets are ones you already use on real projects — share them so other developers can install them in one command.
+
+## Feedback & requests
+
+Have feedback, suggestions, or feature requests? I'd love to hear from you.
+
+📧 **Email:** [patrickpolicarpio08@gmail.com](mailto:patrickpolicarpio08@gmail.com)
+
+Whether it's a Skill you want added, a Rule for your stack, a bug report, or an idea to improve the CLI — send a note. Every message helps shape the product.
+
+## Support
+
+If Noah Cursor saves you time, consider buying me a coffee — it helps keep the CLI and registry maintained.
+
+<p align="center">
+  <a href="https://www.buymeacoffee.com/itsmenoahpoli">
+    <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="50" />
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://www.buymeacoffee.com/itsmenoahpoli">
+    <img src="assets/qr-code.png" alt="Buy Me a Coffee QR code" width="220" />
+  </a>
+  <br />
+  <sub>Scan to support on Buy Me a Coffee</sub>
+</p>
 
 ## License
 
-MIT
+MIT © [Noah Poli](https://github.com/itsmenoahpoli)

package/dist/noah-registry/manifest.json

@@ -39,6 +39,12 @@
       "version": "1.0.0",
       "description": "Run bundled node-doctor (Knip + hygiene), fix findings, verify features still work",
       "tags": ["node", "knip", "doctor", "qa", "cli"]
+    },
+    {
+      "id": "generate-readme",
+      "version": "1.0.0",
+      "description": "Generate a project README with stack, deps, prerequisites, and setup guide",
+      "tags": ["docs", "readme", "documentation", "setup"]
     }
   ],
   "rules": [

package/dist/noah-registry/skills/generate-readme/SKILL.md

@@ -0,0 +1,166 @@
+---
+name: generate-readme
+description: >-
+  Generates a project README with title, description, tech stack, dependencies,
+  prerequisites, installation, and setup guide from the real codebase. Use when
+  the user runs /generate-readme, asks for a project README, docs for setup, or
+  to rewrite/improve README.md.
+disable-model-invocation: true
+---
+
+# /generate-readme
+
+Generate (or rewrite) a **project `README.md`** from the actual repository — not generic filler.
+
+Infer title, description, tech stack, dependencies, prerequisites, and setup steps from real config and scripts. Prefer accuracy over marketing. Do not invent APIs, env vars, or commands that are not in the project.
+
+## Workflow
+
+Copy this checklist and track progress:
+
+```
+README Progress:
+- [ ] 1. Inspect project identity and stack
+- [ ] 2. Collect prerequisites, deps, and scripts
+- [ ] 3. Draft README from the template
+- [ ] 4. Write README.md (preserve intentional extras)
+- [ ] 5. Sanity-check commands and report
+```
+
+### 1. Inspect project identity and stack
+
+From the project root, gather facts (read only what exists):
+
+| Source | Extract |
+|--------|---------|
+| `package.json` / `composer.json` / `pyproject.toml` / `go.mod` / `Cargo.toml` | name, description, version, scripts, engines, deps |
+| `nest-cli.json`, `next.config.*`, `vite.config.*`, `angular.json`, `nuxt.config.*` | framework |
+| `artisan`, `manage.py`, `Dockerfile`, `docker-compose*.yml` | runtime / services |
+| `.env.example`, `.env.sample`, `*.env.example` | required env vars (names only — never real secrets) |
+| existing `README.md` | keep badges, license links, or sections the user clearly wants |
+
+Detect primary stack (examples): Node/TypeScript, NestJS, Next.js, React/Vite, Laravel/PHP, Python, Go, monorepo (list workspaces).
+
+If the repo is empty or not a software project, stop and say so.
+
+### 2. Collect prerequisites, deps, and scripts
+
+Document:
+
+1. **Prerequisites** — language/runtime versions (`engines`, `.nvmrc`, `.php-version`, `volta`, CI matrix), package managers, Docker/DB only if the project actually uses them.
+2. **Dependencies** — summarize from lock/manifests: runtime vs dev; group by role (framework, DB, auth, UI). Do not dump every transitive package.
+3. **Install / setup commands** — copy exact scripts from the package manager files (`npm ci`, `composer install`, `php artisan key:generate`, etc.). Prefer the package manager the repo already uses (lockfile wins: `pnpm-lock.yaml` → pnpm, `yarn.lock` → yarn, `bun.lock*` → bun, else npm / composer).
+4. **Run / test / build** — from scripts: `dev`/`start`, `build`, `test`, `lint`.
+5. **Optional** — migrations, seeders, queue workers, Storybook — only if present.
+
+Never paste secrets from `.env`. Only document variable **names** from examples.
+
+### 3. Draft README from the template
+
+Use this structure unless the user asks for a different outline. Omit sections that do not apply (do not leave empty stubs).
+
+```markdown
+# <Project Title>
+
+<One-paragraph description: what it is and who it is for.>
+
+## Tech stack
+
+- <Language / runtime>
+- <Framework(s)>
+- <Key libraries / services>
+
+## Prerequisites
+
+- <Tool> <version constraint if known>
+- …
+
+## Dependencies
+
+### Runtime
+- …
+
+### Development
+- …
+
+## Installation
+
+\`\`\`bash
+# clone (if public URL known)
+git clone <url>
+cd <dir>
+
+# install
+<package-manager install>
+\`\`\`
+
+## Setup
+
+1. Copy env example: `cp .env.example .env`
+2. <configure env vars — list names>
+3. <migrate / generate keys / link storage — only if applicable>
+
+## Usage
+
+\`\`\`bash
+<dev server command>
+\`\`\`
+
+| Command | Description |
+|---------|-------------|
+| `…` | … |
+
+## Project structure
+
+\`\`\`text
+<short tree of important top-level dirs only>
+\`\`\`
+
+## Testing
+
+\`\`\`bash
+<test command>
+\`\`\`
+
+## License
+
+<from LICENSE / package.json, or omit if unknown>
+```
+
+Rules:
+
+- Title: human-readable (from package name or repo name); not a raw npm id unless that is the product name.
+- Description: 1–3 sentences grounded in the codebase or existing README — no buzzword salad.
+- Commands: fenced bash, copy-pasteable from repo root.
+- Keep tone direct and concise (same bar as good open-source READMEs).
+- Absolute image URLs only if the user wants a banner and a public host exists; do not break private-repo badges.
+
+### 4. Write README.md
+
+- Default path: `README.md` at repo root.
+- If `README.md` already exists: **replace** with the generated doc unless the user asked to “update” or “append” — then merge carefully and keep custom sections (Changelog, Contributing, Security) when they look intentional.
+- Do not commit or push unless the user asks.
+- Do not delete `LICENSE` or other docs.
+
+### 5. Sanity-check and report
+
+Confirm every command in the README matches a real script or documented binary. Fix mismatches before finishing.
+
+Report:
+
+```markdown
+## README generated
+
+- Path: README.md
+- Stack detected: <…>
+- Sections included: <list>
+- Skipped (N/A): <list>
+- Follow-ups: <missing .env.example, unclear start script, etc.>
+```
+
+## Safety
+
+- Never invent install steps for tools the project does not use.
+- Never commit `.env` or secrets.
+- Never overwrite a README with placeholder lorem ipsum.
+- If multiple apps exist in a monorepo, either document the root workspace clearly or ask which package to document first (default: root + note workspaces).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "noah-cursor",
-  "version": "1.5.2",
+  "version": "1.5.4",
   "description": "Install Noah's reusable Cursor assets (Skills, Rules, Prompts, MCP configs, Presets)",
   "type": "module",
   "bin": {