create-mcp-use-app 0.9.4 → 0.10.0-canary.0

package/README.md

@@ -112,6 +112,11 @@ npx create-mcp-use-app my-project
 npx create-mcp-use-app my-project --template apps-sdk
 npx create-mcp-use-app my-project --template mcp-ui
 
+# Use a GitHub repository as a template
+npx create-mcp-use-app my-project --template owner/repo
+npx create-mcp-use-app my-project --template https://github.com/owner/repo
+npx create-mcp-use-app my-project --template owner/repo#branch-name
+
 # Use a specific package manager
 npx create-mcp-use-app my-project --npm
 npx create-mcp-use-app my-project --yarn
@@ -159,6 +164,29 @@ The mcp-ui template includes:
 
 Best for building MCP servers with rich interactive UI components.
 
+### GitHub Repository Templates
+
+You can use any GitHub repository as a template by providing the repository URL:
+
+```bash
+# Short format (owner/repo)
+npx create-mcp-use-app my-project --template owner/repo
+
+# Full URL format
+npx create-mcp-use-app my-project --template https://github.com/owner/repo
+
+# With specific branch
+npx create-mcp-use-app my-project --template owner/repo#branch-name
+npx create-mcp-use-app my-project --template https://github.com/owner/repo#branch-name
+```
+
+The repository will be cloned and its contents will be used to initialize your project. This is useful for:
+- Using community templates
+- Sharing custom templates within your organization
+- Creating projects from existing repositories
+
+**Note:** Git must be installed and available in your PATH to use GitHub repository templates.
+
 ---
 
 ## 🏗️ What Gets Installed

package/dist/index.js

@@ -6,11 +6,12 @@ import { Command } from "commander";
 import { render } from "ink";
 import SelectInput from "ink-select-input";
 import TextInput from "ink-text-input";
-import { execSync, spawn } from "child_process";
+import { execSync, spawn, spawnSync } from "child_process";
 import {
   copyFileSync,
   existsSync,
   mkdirSync,
+  mkdtempSync,
   readdirSync,
   readFileSync,
   rmSync,
@@ -18,6 +19,7 @@ import {
 } from "fs";
 import { dirname, join, resolve } from "path";
 import { fileURLToPath } from "url";
+import { tmpdir } from "os";
 import ora from "ora";
 import React, { useState } from "react";
 import { Box, Text } from "ink";
@@ -279,7 +281,7 @@ function listTemplates() {
 }
 program.name("create-mcp-use-app").description("Create a new MCP server project").version(packageJson.version).argument("[project-name]", "Name of the MCP server project").option(
   "-t, --template <template>",
-  "Template to use (starter, mcp-ui, apps-sdk)",
+  "Template to use (starter, mcp-ui, apps-sdk) or GitHub repo URL (owner/repo or https://github.com/owner/repo)",
   "starter"
 ).option("--list-templates", "List all available templates").option("--install", "Install dependencies after creating project").option("--no-git", "Skip initializing a git repository").option("--dev", "Use workspace dependencies for development").option("--canary", "Use canary versions of packages").option("--yarn", "Use yarn as package manager").option("--npm", "Use npm as package manager").option("--pnpm", "Use pnpm as package manager").action(
   async (projectName, options) => {
@@ -479,7 +481,7 @@ program.name("create-mcp-use-app").description("Create a new MCP server project"
           );
         }
       }
-      if (options.git) {
+      if (options.git && !isGitHubRepoUrl(validatedTemplate)) {
         tryGitInit(projectPath);
       }
       console.log("");
@@ -554,8 +556,127 @@ program.name("create-mcp-use-app").description("Create a new MCP server project"
     }
   }
 );
+function parseGitHubRepoUrl(url) {
+  const trimmed = url.trim();
+  let match = trimmed.match(
+    /^https?:\/\/(?:www\.)?github\.com\/([^/]+)\/([^/#]+?)(?:\.git)?(?:\/tree\/([^/]+))?(?:#(.+))?$/
+  );
+  if (match) {
+    const result = {
+      owner: match[1],
+      repo: match[2],
+      branch: match[3] || match[4] || void 0
+    };
+    return validateGitHubRepoInfo(result) ? result : null;
+  }
+  match = trimmed.match(
+    /^(?:www\.)?github\.com\/([^/]+)\/([^/#]+?)(?:\.git)?(?:#(.+))?$/
+  );
+  if (match) {
+    const result = {
+      owner: match[1],
+      repo: match[2],
+      branch: match[3] || void 0
+    };
+    return validateGitHubRepoInfo(result) ? result : null;
+  }
+  match = trimmed.match(/^([^/#]+)\/([^/#]+?)(?:#(.+))?$/);
+  if (match) {
+    const result = {
+      owner: match[1],
+      repo: match[2],
+      branch: match[3] || void 0
+    };
+    return validateGitHubRepoInfo(result) ? result : null;
+  }
+  return null;
+}
+function validateGitHubRepoInfo(info) {
+  const validIdentifier = /^[a-zA-Z0-9_-]+$/;
+  const validBranch = /^[a-zA-Z0-9_./-]+$/;
+  if (!validIdentifier.test(info.owner) || !validIdentifier.test(info.repo)) {
+    return false;
+  }
+  if (info.branch && !validBranch.test(info.branch)) {
+    return false;
+  }
+  return true;
+}
+function isGitHubRepoUrl(template) {
+  return parseGitHubRepoUrl(template) !== null;
+}
+async function cloneGitHubRepo(repoInfo, tempDir) {
+  const versionCheck = spawnSync("git", ["--version"], {
+    stdio: "ignore",
+    shell: false
+  });
+  if (versionCheck.status !== 0 || versionCheck.error) {
+    console.error(
+      chalk.red("\u274C Git is not installed or not available in PATH")
+    );
+    console.error(
+      chalk.yellow("   Please install Git to use GitHub repository templates")
+    );
+    process.exit(1);
+  }
+  const repoUrl = `https://github.com/${repoInfo.owner}/${repoInfo.repo}.git`;
+  const branch = repoInfo.branch || "main";
+  const spinner = ora(`Cloning repository from GitHub...`).start();
+  const cloneWithBranch = (branchName) => {
+    const result = spawnSync(
+      "git",
+      ["clone", "--depth", "1", "--branch", branchName, repoUrl, tempDir],
+      {
+        stdio: "pipe",
+        shell: false
+      }
+    );
+    if (result.status !== 0) {
+      const errorMessage2 = result.stderr?.toString() || result.stdout?.toString() || "Unknown error";
+      return {
+        success: false,
+        error: new Error(errorMessage2)
+      };
+    }
+    return { success: true };
+  };
+  const cloneResult = cloneWithBranch(branch);
+  if (cloneResult.success) {
+    spinner.succeed("Repository cloned successfully");
+    return tempDir;
+  }
+  if (!repoInfo.branch) {
+    spinner.text = `Branch "${branch}" not found, trying "main"...`;
+    const mainResult = cloneWithBranch("main");
+    if (mainResult.success) {
+      spinner.succeed("Repository cloned successfully (using main branch)");
+      return tempDir;
+    }
+    spinner.text = `Branch "main" not found, trying "master"...`;
+    const masterResult = cloneWithBranch("master");
+    if (masterResult.success) {
+      spinner.succeed("Repository cloned successfully (using master branch)");
+      return tempDir;
+    }
+  }
+  spinner.fail("Failed to clone repository");
+  console.error(chalk.red(`\u274C Error cloning repository: ${repoUrl}`));
+  if (repoInfo.branch) {
+    console.error(chalk.yellow(`   Branch "${repoInfo.branch}" may not exist`));
+  }
+  const errorMessage = cloneResult.error?.message || "Unknown error";
+  if (errorMessage.includes("not found")) {
+    console.error(chalk.yellow(`   Repository may not exist or is private`));
+  } else {
+    console.error(chalk.yellow(`   ${errorMessage}`));
+  }
+  throw cloneResult.error || new Error("Failed to clone repository");
+}
 function validateTemplateName(template) {
   const sanitized = template.trim();
+  if (isGitHubRepoUrl(sanitized)) {
+    return sanitized;
+  }
   if (sanitized.includes("..") || sanitized.includes("/") || sanitized.includes("\\")) {
     console.error(chalk.red("\u274C Invalid template name"));
     console.error(
@@ -575,6 +696,31 @@ function validateTemplateName(template) {
   return sanitized;
 }
 async function copyTemplate(projectPath, template, versions, isDevelopment = false, useCanary = false) {
+  const repoInfo = parseGitHubRepoUrl(template);
+  if (repoInfo) {
+    const tempDir = mkdtempSync(join(tmpdir(), "create-mcp-use-app-"));
+    try {
+      await cloneGitHubRepo(repoInfo, tempDir);
+      copyDirectoryWithProcessing(
+        tempDir,
+        projectPath,
+        versions,
+        isDevelopment,
+        useCanary
+      );
+    } finally {
+      try {
+        rmSync(tempDir, { recursive: true, force: true });
+      } catch (error) {
+        if (process.env.NODE_ENV === "development") {
+          console.warn(
+            `Warning: Failed to clean up temp directory: ${tempDir}`
+          );
+        }
+      }
+    }
+    return;
+  }
   const templatePath = join(__dirname, "templates", template);
   if (!existsSync(templatePath)) {
     console.error(chalk.red(`\u274C Template "${template}" not found!`));
@@ -596,6 +742,9 @@ async function copyTemplate(projectPath, template, versions, isDevelopment = fal
     console.log(
       '\u{1F4A1} Tip: Use "apps-sdk" template for a MCP server with OpenAI Apps SDK integration'
     );
+    console.log(
+      '\u{1F4A1} Tip: Use a GitHub repo URL like "owner/repo" or "https://github.com/owner/repo" to use a custom template'
+    );
     process.exit(1);
   }
   copyDirectoryWithProcessing(
@@ -609,6 +758,9 @@ async function copyTemplate(projectPath, template, versions, isDevelopment = fal
 function copyDirectoryWithProcessing(src, dest, versions, isDevelopment, useCanary = false) {
   const entries = readdirSync(src, { withFileTypes: true });
   for (const entry of entries) {
+    if (entry.name === ".git") {
+      continue;
+    }
     const srcPath = join(src, entry.name);
     const destPath = join(dest, entry.name);
     if (entry.isDirectory()) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-mcp-use-app",
-  "version": "0.9.4",
+  "version": "0.10.0-canary.0",
   "type": "module",
   "description": "Create MCP-Use apps with one command",
   "author": "mcp-use, Inc.",