@mallardbay/cursor-rules 1.0.10 → 1.0.12

package/README.md

@@ -1,10 +1,17 @@
 # Cursor Rules
 
-A tool for managing Cursor IDE rules across different environment types with shared base configurations.
+A tool for managing Cursor IDE rules and Claude Code configuration across different environment types with shared base configurations.
 
 ## Overview
 
-This project provides a structured way to manage Cursor IDE rules for different development environments while maintaining a shared base configuration. It supports three main environment types:
+This project provides a structured way to manage AI agent rules and skills for different development environments while maintaining a shared base configuration. It generates:
+
+- **Cursor IDE**: `.cursor/rules/*.mdc` files and `.cursor/skills/*/SKILL.md` files
+- **Claude Code**: A combined `CLAUDE.md` file and `.claude/skills/*/SKILL.md` files
+- **Codex**: `.codex/skills/*/SKILL.md` files
+- **Cross-platform Skills**: Skills are automatically copied to all three platform directories for maximum compatibility
+
+It supports three main environment types:
 
 -   `frontend`: Basic frontend development rules
 -   `frontend-lib`: Extended rules for frontend library development, inheriting from frontend rules
@@ -45,12 +52,13 @@ npx @mallardbay/cursor-rules backend
 
 ## Project Structure
 
-The rules are organized in the following directory structure:
+The rules and skills are organized in the following directory structure:
 
 ```
 .cursor/
 ├── shared/
-│   └── rules/     # Shared base rules
+│   ├── rules/     # Shared base rules
+│   └── skills/    # Shared skills (installable workflows)
 ├── frontend/
 │   └── rules/     # Frontend-specific rules
 ├── frontend-lib/
@@ -66,6 +74,41 @@ The rules follow an inheritance pattern:
 -   All environments include the shared base rules
 -   `frontend-lib` inherits rules from both `frontend` and `frontend-lib` directories
 
+## Output
+
+Running the setup script generates:
+
+```
+your-project/
+├── .cursor/
+│   ├── rules/          # Cursor IDE rules (*.mdc files)
+│   │   ├── code-quality.mdc
+│   │   ├── testing.mdc
+│   │   └── ...
+│   └── skills/         # Cursor Skills (installable workflows)
+│       ├── example-skill/
+│       │   └── SKILL.md
+│       └── create-pr/
+│           └── SKILL.md
+├── .claude/
+│   └── skills/         # Claude Code Skills (same skills)
+│       ├── example-skill/
+│       │   └── SKILL.md
+│       └── create-pr/
+│           └── SKILL.md
+├── .codex/
+│   └── skills/         # Codex Skills (same skills)
+│       ├── example-skill/
+│       │   └── SKILL.md
+│       └── create-pr/
+│           └── SKILL.md
+└── CLAUDE.md           # Claude Code configuration (combined rules)
+```
+
+The `CLAUDE.md` file combines all applicable rules into a single file, with YAML frontmatter stripped for compatibility with Claude Code.
+
+Skills are automatically discovered by Cursor, Claude Code, and Codex, and can be invoked with `/skill-name` in chat. The setup script copies skills to all three platform directories for cross-platform compatibility.
+
 ## Development
 
 ### Adding New Rules
@@ -73,14 +116,39 @@ The rules follow an inheritance pattern:
 1. Create `.mdc` files in the appropriate rules directory
 2. Rules will be automatically copied to `.cursor/rules/` when running the setup script
 
+### Adding New Skills
+
+1. Create a skill directory in `.cursor/shared/skills/your-skill-name/`
+2. Add a `SKILL.md` file with YAML frontmatter and instructions
+3. Optionally add `scripts/`, `references/`, or `assets/` directories
+4. Skills will be automatically copied to `.cursor/skills/`, `.claude/skills/`, and `.codex/skills/` when running the setup script for cross-platform compatibility
+5. See [SKILLS.md](SKILLS.md) for detailed documentation
+
 ### Directory Structure
 
 -   `bin/setup-cursor.sh`: Main setup script
 -   `.cursor/shared/rules/`: Shared base rules
+-   `.cursor/shared/skills/`: Shared skills (installable workflows)
 -   `.cursor/frontend/rules/`: Frontend-specific rules
 -   `.cursor/frontend-lib/rules/`: Frontend library-specific rules
 -   `.cursor/backend/rules/`: Backend-specific rules
 
+## Skills
+
+This repository includes example Cursor Skills that can be installed:
+
+- **example-skill**: Template for creating new skills
+- **create-pr**: Workflow for creating well-structured pull requests
+- **prep-for-pr**: Prepare your branch for a PR by checking and fixing code quality issues
+- **review-pr**: Systematically review someone else's PR with code quality, security, and standards checks
+- **address-pr-feedback**: Find PR by branch, review feedback, create plan, implement fixes, and resolve GitHub conversations
+
+See [SKILLS.md](SKILLS.md) for complete documentation on:
+- Creating new skills
+- Installing skills from GitHub
+- Skill structure and format
+- Best practices
+
 ## License
 
 [Add your license information here]

package/bin/setup-cursor.sh

@@ -1,5 +1,6 @@
 #!/usr/bin/env bash
 # setup-cursor.sh — frontend & frontend-lib layering with shared base
+# Also generates CLAUDE.md for Claude Code
 
 set -e
 
@@ -11,15 +12,28 @@ if [ -z "$ENV_TYPE" ]; then
   exit 1
 fi
 
-SCRIPT_PATH="$(realpath "$0")"
-SRC_DIR="$(cd "$(dirname "$SCRIPT_PATH")/.." && pwd)"
+# Get the real path of the script (portable across Mac/Linux)
+get_real_path() {
+  local path="$1"
+  cd "$(dirname "$path")" && echo "$(pwd -P)/$(basename "$path")"
+}
+SCRIPT_PATH="$(get_real_path "$0")"
+SRC_DIR="$(cd "$(dirname "$SCRIPT_PATH")/.." && pwd -P)"
 
 SHARED_DIR="$SRC_DIR/.cursor/shared/rules"
 FRONTEND_DIR="$SRC_DIR/.cursor/frontend/rules"
 FRONTEND_LIB_DIR="$SRC_DIR/.cursor/frontend-lib/rules"
 BACKEND_DIR="$SRC_DIR/.cursor/backend/rules"
+SHARED_SKILLS_DIR="$SRC_DIR/.cursor/shared/skills"
 
 mkdir -p .cursor/rules
+mkdir -p .cursor/skills
+mkdir -p .claude/skills
+mkdir -p .codex/skills
+
+# Temporary file to collect CLAUDE.md content
+CLAUDE_MD_TEMP=$(mktemp)
+trap 'rm -f "$CLAUDE_MD_TEMP"' EXIT
 
 copy_rules() {
   local DIR="$1"
@@ -29,20 +43,69 @@ copy_rules() {
   fi
 }
 
+copy_skills() {
+  local DIR="$1"
+  if [ -d "$DIR" ]; then
+    echo "Copying skills from: $DIR"
+    # Copy each skill directory to all three locations for cross-platform compatibility
+    for skill_dir in "$DIR"/*; do
+      if [ -d "$skill_dir" ] && [ -f "$skill_dir/SKILL.md" ]; then
+        skill_name=$(basename "$skill_dir")
+        echo "  - Copying skill: $skill_name"
+        # Copy to Cursor, Claude, and Codex skill directories
+        cp -r "$skill_dir" .cursor/skills/ 2>/dev/null || true
+        cp -r "$skill_dir" .claude/skills/ 2>/dev/null || true
+        cp -r "$skill_dir" .codex/skills/ 2>/dev/null || true
+      fi
+    done
+  fi
+}
+
+# Append rules to CLAUDE.md (strips YAML frontmatter)
+append_to_claude_md() {
+  local DIR="$1"
+  if [ -d "$DIR" ]; then
+    for file in "$DIR"/*.mdc; do
+      [ -f "$file" ] || continue
+      # Add separator
+      echo "" >> "$CLAUDE_MD_TEMP"
+      echo "---" >> "$CLAUDE_MD_TEMP"
+      echo "" >> "$CLAUDE_MD_TEMP"
+      # Strip YAML frontmatter (content between --- markers) and append
+      awk '
+        BEGIN { in_frontmatter=0; found_end=0 }
+        /^---$/ && !found_end {
+          if (in_frontmatter) { found_end=1; next }
+          else { in_frontmatter=1; next }
+        }
+        !in_frontmatter || found_end { print }
+      ' "$file" >> "$CLAUDE_MD_TEMP"
+    done
+  fi
+}
+
 # Always include shared rules
 copy_rules "$SHARED_DIR"
+append_to_claude_md "$SHARED_DIR"
+
+# Always include shared skills
+copy_skills "$SHARED_SKILLS_DIR"
 
 # Inheritance handling
 case "$ENV_TYPE" in
   frontend)
     copy_rules "$FRONTEND_DIR"
+    append_to_claude_md "$FRONTEND_DIR"
     ;;
   backend)
     copy_rules "$BACKEND_DIR"
+    append_to_claude_md "$BACKEND_DIR"
     ;;
   frontend-lib)
     copy_rules "$FRONTEND_DIR"
     copy_rules "$FRONTEND_LIB_DIR"
+    append_to_claude_md "$FRONTEND_DIR"
+    append_to_claude_md "$FRONTEND_LIB_DIR"
     ;;
   *)
     echo "Unknown environment type: $ENV_TYPE"
@@ -50,4 +113,16 @@ case "$ENV_TYPE" in
     ;;
 esac
 
-echo ".cursor/rules setup complete for '$ENV_TYPE'"
+# Generate CLAUDE.md
+mv "$CLAUDE_MD_TEMP" CLAUDE.md
+trap - EXIT
+echo "CLAUDE.md generated for Claude Code"
+
+if [ -d ".cursor/skills" ] && [ "$(ls -A .cursor/skills 2>/dev/null)" ]; then
+  echo "Skills installed in:"
+  echo "  - .cursor/skills/ (Cursor)"
+  echo "  - .claude/skills/ (Claude Code)"
+  echo "  - .codex/skills/ (Codex)"
+fi
+
+echo "Setup complete for '$ENV_TYPE' (Cursor + Claude + Codex)"

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mallardbay/cursor-rules",
-    "version": "1.0.10",
+    "version": "1.0.12",
     "description": "Mallard Bay shared cursor rules",
     "main": "bin/setup-cursor.sh",
     "repository": "git@github.com:mallardbay/cursor-rules.git",