cursor-kit-cli 1.3.0-beta → 1.3.0-beta.2

package/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2024 duongductrong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -5,8 +5,8 @@
 <h1 align="center">✦ Cursor Kit ✦</h1>
 
 <p align="center">
-  <b>Supercharge your Cursor IDE with rules & commands</b><br/>
-  <sub>A CLI toolkit to manage, share, and sync Cursor IDE configurations</sub>
+  <b>Supercharge your AI IDE with rules & commands</b><br/>
+  <sub>A CLI toolkit to manage, share, and sync Cursor IDE and GitHub Copilot configurations</sub>
 </p>
 
 <p align="center">
@@ -44,6 +44,7 @@ ck init
 - **📋 Rules** - Project-specific AI behavior guidelines
 - **🎓 Skills** - Comprehensive guides with references for specialized domains
 - **🔄 Sync** - Keep configurations updated from the community
+- **🎯 Multi-Target** - Support for both Cursor IDE and GitHub Copilot
 - **🖥️ Multi-Instance** - Run multiple Cursor accounts simultaneously (macOS)
 - **🎨 Beautiful CLI** - Delightful terminal experience
 
@@ -51,17 +52,23 @@ ck init
 
 ### `init`
 
-Initialize `.cursor/commands`, `.cursor/rules`, and `.cursor/skills` in your project with curated templates.
+Initialize `.cursor/commands`, `.cursor/rules`, and `.cursor/skills` in your project with curated templates. Supports both Cursor IDE and GitHub Copilot.
 
 ```bash
-cursor-kit init           # Initialize commands, rules, and skills
-cursor-kit init -c        # Only initialize commands
-cursor-kit init -r        # Only initialize rules
-cursor-kit init -s        # Only initialize skills
-cursor-kit init -f        # Force overwrite existing files
-cursor-kit init -a        # Install all templates without selection prompts
+cursor-kit init                    # Interactive: choose Cursor or GitHub Copilot
+cursor-kit init -t cursor          # Initialize for Cursor IDE (.cursor/)
+cursor-kit init -t github-copilot  # Initialize for GitHub Copilot (.github/copilot-instructions/)
+cursor-kit init -c                 # Only initialize commands
+cursor-kit init -r                 # Only initialize rules
+cursor-kit init -s                 # Only initialize skills
+cursor-kit init -f                 # Force overwrite existing files
+cursor-kit init -a                 # Install all templates without selection prompts
 ```
 
+**Target options:**
+- `cursor` (default) - Creates `.cursor/` directory structure for Cursor IDE
+- `github-copilot` - Creates `.github/copilot-instructions.md` and related structure for GitHub Copilot
+
 ### `add`
 
 Interactively create a new command, rule, or skill with a starter template.
@@ -152,7 +159,9 @@ cursor-kit instance -a remove -n "Cursor Personal"
 
 ## 📁 Directory Structure
 
-After running `cursor-kit init`, your project will have:
+After running `cursor-kit init`, your project will have different structures depending on the target:
+
+### Cursor IDE (default)
 
 ```
 your-project/
@@ -197,6 +206,36 @@ your-project/
             └── references/
 ```
 
+### GitHub Copilot
+
+```
+your-project/
+└── .github/
+    ├── copilot-instructions.md    # Main instructions file
+    └── copilot-instructions/      # Organized instructions
+        ├── commands/              # Prompt templates (.md)
+        │   ├── docs.md
+        │   ├── explain.md
+        │   ├── fix.md
+        │   ├── implement.md
+        │   ├── refactor.md
+        │   ├── review.md
+        │   └── test.md
+        ├── rules/                 # AI behavior rules (.md)
+        │   ├── coding-style.md
+        │   ├── git.md
+        │   └── toc.md
+        └── skills/                # Comprehensive guides with references
+            ├── aesthetic/
+            │   ├── SKILL.md
+            │   ├── assets/
+            │   └── references/
+            ├── backend-development/
+            │   ├── SKILL.md
+            │   └── references/
+            └── ... (other skills)
+```
+
 ## 🎯 Included Templates
 
 ### Commands

package/dist/cli.cjs

@@ -201,7 +201,7 @@ function getLocalManifest() {
   }
   return {
     commands: dirExists(commandsDir) ? listFiles(commandsDir, ".md") : [],
-    rules: dirExists(rulesDir) ? listFiles(rulesDir, ".mdc") : [],
+    rules: dirExists(rulesDir) ? listFiles(rulesDir, ".md") : [],
     skills: dirExists(skillsDir) ? listDirs(skillsDir) : []
   };
 }
@@ -211,6 +211,12 @@ function getLocalTemplateContent(type, filename) {
   if (fileExists(filePath)) {
     return readFile(filePath);
   }
+  if (type === "rules" && filename.endsWith(".md")) {
+    const mdcPath = filePath.replace(/\.md$/, ".mdc");
+    if (fileExists(mdcPath)) {
+      return readFile(mdcPath);
+    }
+  }
   return null;
 }
 function getLocalSkillDir(skillName) {
@@ -221,12 +227,29 @@ function getLocalSkillDir(skillName) {
   }
   return null;
 }
-function copyLocalSkill(skillName, targetDir) {
+function convertMdToMdc(filename) {
+  return filename.replace(/\.md$/, ".mdc");
+}
+function transformTocContentForCursor(content) {
+  content = content.replace(/\]\(\.\.\/skills\/([^/]+)\/SKILL\.md\)/g, "](../skills/$1/SKILL.mdc)");
+  content = content.replace(/\]\(\.\/([^)]+)\.md\)/g, "](./$1.mdc)");
+  return content;
+}
+function copyLocalSkill(skillName, targetDir, convertToMdc = false) {
   const sourcePath = getLocalSkillDir(skillName);
   if (!sourcePath) return false;
   const destPath = (0, import_node_path2.join)(targetDir, skillName);
   ensureDir(destPath);
   copyDir(sourcePath, destPath);
+  if (convertToMdc) {
+    const skillMdPath = (0, import_node_path2.join)(destPath, "SKILL.md");
+    const skillMdcPath = (0, import_node_path2.join)(destPath, "SKILL.mdc");
+    if (fileExists(skillMdPath)) {
+      const content = readFile(skillMdPath);
+      writeFile(skillMdcPath, content);
+      deleteFile(skillMdPath);
+    }
+  }
   return true;
 }
 async function fetchTemplateManifest() {
@@ -372,7 +395,7 @@ async function installCopilotRules(rulesDir, selectedRules) {
   for (const [filename, content] of rulesMap) {
     const frontmatter = extractFrontmatter(content);
     const cleanContent = stripFrontmatter(content);
-    const mdFilename = filename.replace(/\.mdc$/, ".md");
+    const mdFilename = filename.endsWith(".md") ? filename : filename.replace(/\.mdc$/, ".md");
     const filePath = (0, import_node_path3.join)(rulesDir, mdFilename);
     writeFile(filePath, cleanContent);
     installed.push(mdFilename);
@@ -392,7 +415,11 @@ async function installCopilotSkills(skillsDir, selectedSkills) {
     const skillTargetDir = (0, import_node_path3.join)(skillsDir, skillName);
     const skillMdcPath = (0, import_node_path3.join)(skillTargetDir, "SKILL.mdc");
     const skillMdPath = (0, import_node_path3.join)(skillTargetDir, "SKILL.md");
-    if (fileExists(skillMdcPath)) {
+    if (fileExists(skillMdPath)) {
+      const content = readFile(skillMdPath);
+      const cleanContent = stripFrontmatter(content);
+      writeFile(skillMdPath, cleanContent);
+    } else if (fileExists(skillMdcPath)) {
       const content = readFile(skillMdcPath);
       const cleanContent = stripFrontmatter(content);
       writeFile(skillMdPath, cleanContent);
@@ -619,16 +646,25 @@ async function handleConflicts(type, conflictingFiles) {
   });
   return strategy;
 }
-async function installTemplates(type, targetDir, selectedTemplates, conflictStrategy) {
+async function installTemplates(type, targetDir, selectedTemplates, conflictStrategy, target) {
   const result = { added: [], skipped: [] };
-  const conflictingFiles = getConflictingFiles(targetDir, selectedTemplates);
+  const expectedFilenames = selectedTemplates.map((filename) => {
+    if (target === "cursor" && type === "rules" && filename.endsWith(".md")) {
+      return convertMdToMdc(filename);
+    }
+    return filename;
+  });
+  const conflictingFiles = getConflictingFiles(targetDir, expectedFilenames);
   let templatesToInstall;
   if (conflictStrategy === "merge") {
     templatesToInstall = selectedTemplates.filter(
-      (t) => !conflictingFiles.includes(t)
+      (t) => {
+        const expectedName = target === "cursor" && type === "rules" && t.endsWith(".md") ? convertMdToMdc(t) : t;
+        return !conflictingFiles.includes(expectedName);
+      }
     );
     result.skipped = conflictingFiles.filter(
-      (f) => selectedTemplates.includes(f)
+      (f) => expectedFilenames.includes(f)
     );
   } else {
     templatesToInstall = selectedTemplates;
@@ -639,13 +675,18 @@ async function installTemplates(type, targetDir, selectedTemplates, conflictStra
   const templates = await fetchMultipleTemplates(type, templatesToInstall);
   ensureDir(targetDir);
   for (const [filename, content] of templates) {
-    const filePath = (0, import_node_path4.join)(targetDir, filename);
-    writeFile(filePath, content);
-    result.added.push(filename);
+    const outputFilename = target === "cursor" && type === "rules" && filename.endsWith(".md") ? convertMdToMdc(filename) : filename;
+    let transformedContent = content;
+    if (target === "cursor" && type === "rules" && filename === "toc.md") {
+      transformedContent = transformTocContentForCursor(content);
+    }
+    const filePath = (0, import_node_path4.join)(targetDir, outputFilename);
+    writeFile(filePath, transformedContent);
+    result.added.push(outputFilename);
   }
   return result;
 }
-async function installSkills(targetDir, selectedSkills, conflictStrategy) {
+async function installSkills(targetDir, selectedSkills, conflictStrategy, target) {
   const result = { added: [], skipped: [] };
   const conflictingDirs = getConflictingDirs(targetDir, selectedSkills);
   let skillsToInstall;
@@ -663,8 +704,9 @@ async function installSkills(targetDir, selectedSkills, conflictStrategy) {
     return result;
   }
   ensureDir(targetDir);
+  const convertToMdc = target === "cursor";
   for (const skillName of skillsToInstall) {
-    const success = copyLocalSkill(skillName, targetDir);
+    const success = copyLocalSkill(skillName, targetDir, convertToMdc);
     if (success) {
       result.added.push(skillName);
     }
@@ -793,7 +835,8 @@ var initCommand = (0, import_citty.defineCommand)({
           "commands",
           commandsDir,
           selectedCommands,
-          commandStrategy
+          commandStrategy,
+          target
         );
         s.stop("Commands installed");
       }
@@ -809,7 +852,10 @@ var initCommand = (0, import_citty.defineCommand)({
           }
           selectedRules = selection;
         }
-        const conflictingRules = getConflictingFiles(rulesDir, selectedRules);
+        const expectedRuleFilenames = selectedRules.map((filename) => {
+          return target === "cursor" && filename.endsWith(".md") ? convertMdToMdc(filename) : filename;
+        });
+        const conflictingRules = getConflictingFiles(rulesDir, expectedRuleFilenames);
         let ruleStrategy = "overwrite";
         if (conflictingRules.length > 0 && !args.force) {
           const strategy = await handleConflicts("rules", conflictingRules);
@@ -824,7 +870,8 @@ var initCommand = (0, import_citty.defineCommand)({
           "rules",
           rulesDir,
           selectedRules,
-          ruleStrategy
+          ruleStrategy,
+          target
         );
         s.stop("Rules installed");
       }
@@ -854,7 +901,8 @@ var initCommand = (0, import_citty.defineCommand)({
         results.skills = await installSkills(
           skillsDir,
           selectedSkills,
-          skillStrategy
+          skillStrategy,
+          target
         );
         s.stop("Skills installed");
       }
@@ -1072,13 +1120,16 @@ var addCommand = (0, import_citty2.defineCommand)({
       displayPath = targetPath;
     } else {
       const targetDir = isCommand ? getCommandsDir() : getRulesDir();
-      const extension = isCommand ? ".md" : ".mdc";
+      const extension = ".md";
       targetPath = (0, import_node_path5.join)(targetDir, `${slug}${extension}`);
       displayPath = targetPath;
     }
-    if (isSkill ? dirExists(targetPath) : fileExists(targetPath)) {
+    const checkPath = isSkill ? targetPath : isCommand ? targetPath : (0, import_node_path5.join)(getRulesDir(), `${slug}.mdc`);
+    const exists = isSkill ? dirExists(targetPath) : fileExists(targetPath) || !isCommand && fileExists(checkPath);
+    if (exists) {
+      const displayName = isSkill ? slug : isCommand ? `${slug}.md` : `${slug}.md/.mdc`;
       const shouldOverwrite = await p3.confirm({
-        message: `${highlight(isSkill ? slug : slug + (isCommand ? ".md" : ".mdc"))} already exists. Overwrite?`,
+        message: `${highlight(displayName)} already exists. Overwrite?`,
         initialValue: false
       });
       if (p3.isCancel(shouldOverwrite) || !shouldOverwrite) {
@@ -1092,21 +1143,37 @@ var addCommand = (0, import_citty2.defineCommand)({
       if (isSkill) {
         ensureDir(targetPath);
         ensureDir((0, import_node_path5.join)(targetPath, "references"));
-        writeFile((0, import_node_path5.join)(targetPath, "SKILL.mdc"), SKILL_TEMPLATE);
+        const skillMdPath = (0, import_node_path5.join)(targetPath, "SKILL.md");
+        writeFile(skillMdPath, SKILL_TEMPLATE);
         writeFile((0, import_node_path5.join)(targetPath, "references", "example.md"), SKILL_REFERENCE_TEMPLATE);
+        const skillMdcPath = (0, import_node_path5.join)(targetPath, "SKILL.mdc");
+        const content = readFile(skillMdPath);
+        writeFile(skillMdcPath, content);
+        deleteFile(skillMdPath);
       } else {
         const targetDir = isCommand ? getCommandsDir() : getRulesDir();
         ensureDir(targetDir);
         const template = isCommand ? COMMAND_TEMPLATE : RULE_TEMPLATE;
-        writeFile(targetPath, template);
+        if (isCommand) {
+          writeFile(targetPath, template);
+        } else {
+          writeFile(targetPath, template);
+          const mdcPath = (0, import_node_path5.join)(targetDir, convertMdToMdc(`${slug}.md`));
+          const content = readFile(targetPath);
+          writeFile(mdcPath, content);
+          deleteFile(targetPath);
+        }
       }
       s.stop(`${itemType.charAt(0).toUpperCase() + itemType.slice(1)} created`);
       console.log();
       if (isSkill) {
         console.log(import_picocolors4.default.dim("  Directory: ") + highlight(displayPath));
         console.log(import_picocolors4.default.dim("  Main file: ") + highlight((0, import_node_path5.join)(displayPath, "SKILL.mdc")));
-      } else {
+      } else if (isCommand) {
         console.log(import_picocolors4.default.dim("  File: ") + highlight(displayPath));
+      } else {
+        const mdcPath = (0, import_node_path5.join)(getRulesDir(), convertMdToMdc(`${slug}.md`));
+        console.log(import_picocolors4.default.dim("  File: ") + highlight(mdcPath));
       }
       console.log();
       p3.outro(