create-skybridge 0.0.0-dev.82cbe25 → 0.0.0-dev.8317c0b

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Alpic
+
+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/dist/index.js

@@ -1,7 +1,9 @@
+import { spawnSync } from "node:child_process";
 import fs from "node:fs";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
 import * as prompts from "@clack/prompts";
+import { downloadTemplate } from "giget";
 import mri from "mri";
 const defaultProjectName = "skybridge-project";
 // prettier-ignore
@@ -12,21 +14,32 @@ Create a new Skybridge project by copying the starter template.
 
 Options:
   -h, --help              show this help message
+  --repo <uri>            use a git repository instead of the built-in template
   --overwrite             remove existing files in target directory
+  --immediate             install dependencies and start development server
+
+Repository URI formats:
+  github:user/repo
+  gitlab:user/repo/subdirectory
+  bitbucket:user/repo#branch
 
 Examples:
   create-skybridge my-app
-  create-skybridge . --overwrite
+  create-skybridge my-app --repo github:alpic-ai/skybridge/examples/ecom-carousel
+  create-skybridge . --overwrite --immediate
 `;
 export async function init(args = process.argv.slice(2)) {
     const argv = mri(args, {
-        boolean: ["help", "overwrite"],
+        boolean: ["help", "overwrite", "immediate"],
+        string: ["repo"],
         alias: { h: "help" },
     });
     const argTargetDir = argv._[0]
         ? sanitizeTargetDir(String(argv._[0]))
         : undefined;
+    const argRepo = argv.repo;
     const argOverwrite = argv.overwrite;
+    const argImmediate = argv.immediate;
     const help = argv.help;
     if (help) {
         console.log(helpMessage);
@@ -43,13 +56,14 @@ export async function init(args = process.argv.slice(2)) {
                 defaultValue: defaultProjectName,
                 placeholder: defaultProjectName,
                 validate: (value) => {
-                    return value.length === 0 || sanitizeTargetDir(value).length > 0
+                    return !value || sanitizeTargetDir(value).length > 0
                         ? undefined
                         : "Invalid project name";
                 },
             });
-            if (prompts.isCancel(projectName))
+            if (prompts.isCancel(projectName)) {
                 return cancel();
+            }
             targetDir = sanitizeTargetDir(projectName);
         }
         else {
@@ -77,8 +91,9 @@ export async function init(args = process.argv.slice(2)) {
                         },
                     ],
                 });
-                if (prompts.isCancel(res))
+                if (prompts.isCancel(res)) {
                     return cancel();
+                }
                 overwrite = res;
             }
             else {
@@ -90,32 +105,132 @@ export async function init(args = process.argv.slice(2)) {
                 emptyDir(targetDir);
                 break;
             case "no":
-                cancel();
-                return;
+                prompts.log.error("Target directory is not empty.");
+                process.exit(1);
         }
     }
     const root = path.join(process.cwd(), targetDir);
-    // 3. Copy the repository
-    prompts.log.step(`Copying template...`);
+    // 3. Download from repo or copy template
     try {
-        const templateDir = fileURLToPath(new URL("../template", import.meta.url));
-        // Copy template to target directory
-        fs.cpSync(templateDir, root, { recursive: true });
-        // Rename _gitignore to .gitignore
-        fs.renameSync(path.join(root, "_gitignore"), path.join(root, ".gitignore"));
-        // Update project name in package.json
-        const name = path.basename(root);
-        for (const dir of ["", "server", "web"]) {
-            const pkgPath = path.join(root, dir, "package.json");
-            const pkg = fs.readFileSync(pkgPath, "utf-8");
-            const fixed = pkg.replace(/apps-sdk-template/g, name);
-            fs.writeFileSync(pkgPath, fixed);
+        if (argRepo) {
+            prompts.log.step(`Downloading ${argRepo}...`);
+            await downloadTemplate(argRepo, { dir: root });
+            prompts.log.success(`Project created in ${root}`);
+        }
+        else {
+            prompts.log.step(`Copying template...`);
+            const templateDir = fileURLToPath(new URL("../template", import.meta.url));
+            // Copy template to target directory
+            fs.cpSync(templateDir, root, {
+                recursive: true,
+                filter: (src) => [".npmrc"].every((file) => !src.endsWith(file)),
+            });
+            // Rename _gitignore to .gitignore
+            fs.renameSync(path.join(root, "_gitignore"), path.join(root, ".gitignore"));
+            prompts.log.success(`Project created in ${root}`);
         }
-        prompts.log.success(`Project created in ${root}`);
-        prompts.outro(`Done! Next steps:\n\n  cd ${targetDir}\n  pnpm install\n  pnpm dev`);
     }
     catch (error) {
-        prompts.log.error("Failed to copy repository");
+        prompts.log.error("Failed to create project from template");
+        console.error(error);
+        process.exit(1);
+    }
+    // Update project name in package.json
+    const pkgPath = path.join(root, "package.json");
+    if (!fs.existsSync(pkgPath)) {
+        prompts.log.error("No package.json found in project");
+        process.exit(1);
+    }
+    try {
+        const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+        pkg.name = path.basename(root);
+        fs.writeFileSync(pkgPath, `${JSON.stringify(pkg, null, 2)}\n`);
+    }
+    catch (error) {
+        prompts.log.error("Failed to update project name in package.json");
+        console.error(error);
+        process.exit(1);
+    }
+    const userAgent = process.env.npm_config_user_agent;
+    const pkgManager = userAgent?.split(" ")[0]?.split("/")[0] || "npm";
+    // 4. Ask about skills installation
+    if (interactive) {
+        const skillsResult = await prompts.confirm({
+            message: "Install the coding agents skills? (recommended)",
+            initialValue: true,
+        });
+        if (prompts.isCancel(skillsResult)) {
+            return cancel();
+        }
+        if (skillsResult) {
+            run([
+                ...getPkgExecCmd(pkgManager, "skills"),
+                "add",
+                "alpic-ai/skybridge",
+                "-s",
+                "chatgpt-app-builder",
+            ], {
+                stdio: "inherit",
+                cwd: targetDir,
+            });
+        }
+    }
+    // 5. Ask about immediate installation
+    let immediate = argImmediate;
+    if (immediate === undefined) {
+        if (interactive) {
+            const immediateResult = await prompts.confirm({
+                message: `Install with ${pkgManager} and start now?`,
+            });
+            if (prompts.isCancel(immediateResult)) {
+                return cancel();
+            }
+            immediate = immediateResult;
+        }
+        else {
+            immediate = false;
+        }
+    }
+    const installCmd = [pkgManager, "install"];
+    const runCmd = [pkgManager];
+    switch (pkgManager) {
+        case "yarn":
+        case "pnpm":
+        case "bun":
+            break;
+        case "deno":
+            runCmd.push("task");
+            break;
+        default:
+            runCmd.push("run");
+    }
+    runCmd.push("dev");
+    if (!immediate) {
+        prompts.outro(`Done! Next steps:
+  cd ${targetDir}
+  ${installCmd.join(" ")}
+  ${runCmd.join(" ")}
+`);
+        return;
+    }
+    prompts.log.step(`Installing dependencies with ${pkgManager}...`);
+    run(installCmd, {
+        stdio: "inherit",
+        cwd: root,
+    });
+    prompts.log.step("Starting dev server...");
+    run(runCmd, {
+        stdio: "inherit",
+        cwd: root,
+    });
+}
+function run([command, ...args], options) {
+    const { status, error } = spawnSync(command, args, options);
+    if (status != null && status > 0) {
+        process.exit(status);
+    }
+    if (error) {
+        console.error(`\n${command} ${args.join(" ")} error!`);
         console.error(error);
         process.exit(1);
     }
@@ -132,18 +247,37 @@ function sanitizeTargetDir(targetDir) {
         // Remove leading/trailing slashes
         .replace(/^\/+|\/+$/g, ""));
 }
-function isEmpty(path) {
-    const files = fs.readdirSync(path);
-    return files.length === 0 || (files.length === 1 && files[0] === ".git");
+// Skip user's SPEC.md and IDE/agent preferences (.idea, .claude, etc.)
+function isSkippedEntry(entry) {
+    return ((entry.name.startsWith(".") && entry.isDirectory()) ||
+        entry.name === "SPEC.md");
+}
+function isEmpty(dirPath) {
+    const entries = fs.readdirSync(dirPath, { withFileTypes: true });
+    return entries.every(isSkippedEntry);
 }
 function emptyDir(dir) {
     if (!fs.existsSync(dir)) {
         return;
     }
-    for (const file of fs.readdirSync(dir)) {
-        if (file === ".git") {
+    for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
+        if (isSkippedEntry(entry)) {
             continue;
         }
-        fs.rmSync(path.resolve(dir, file), { recursive: true, force: true });
+        fs.rmSync(path.join(dir, entry.name), { recursive: true, force: true });
+    }
+}
+function getPkgExecCmd(pkgManager, cmd) {
+    switch (pkgManager) {
+        case "yarn":
+            return ["yarn", "dlx", cmd];
+        case "pnpm":
+            return ["pnpm", "dlx", cmd];
+        case "bun":
+            return ["bunx", cmd];
+        case "deno":
+            return ["deno", "run", "-A", `npm:${cmd}`];
+        default:
+            return ["npx", cmd];
     }
 }

package/dist/index.test.js

@@ -1,19 +1,33 @@
 import { randomBytes } from "node:crypto";
 import fs from "node:fs/promises";
 import path from "node:path";
-import { afterEach, beforeEach, describe, it } from "vitest";
+import { afterEach, beforeEach, describe, expect, it } from "vitest";
 import { init } from "./index.js";
 describe("create-skybridge", () => {
     let tempDirName;
-    beforeEach(async () => {
+    beforeEach(() => {
         tempDirName = `test-${randomBytes(2).toString("hex")}`;
     });
     afterEach(async () => {
-        await fs.rm(path.join(process.cwd(), tempDirName), { recursive: true });
+        await fs.rm(path.join(process.cwd(), tempDirName), {
+            recursive: true,
+            force: true,
+        });
     });
-    it("should scaffold a new project", async () => {
+    it("should copy the template", async () => {
         const name = `../../${tempDirName}//project$`;
         await init([name]);
         await fs.access(path.join(process.cwd(), tempDirName, "project", ".gitignore"));
+        expect(fs.access(path.join(process.cwd(), tempDirName, "project", ".npmrc"))).rejects.toThrowError();
+    });
+    it("should download template from repo", async () => {
+        const name = `../../${tempDirName}//project$`;
+        await init([
+            name,
+            "--repo",
+            "github:alpic-ai/skybridge/examples/ecom-carousel",
+        ]);
+        await fs.access(path.join(process.cwd(), tempDirName, "project", ".gitignore"));
+        expect(fs.access(path.join(process.cwd(), tempDirName, "project", ".npmrc"))).rejects.toThrowError();
     });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-skybridge",
-  "version": "0.0.0-dev.82cbe25",
+  "version": "0.0.0-dev.8317c0b",
   "type": "module",
   "license": "MIT",
   "author": "Alpic",
@@ -16,21 +16,20 @@
     "dist",
     "template"
   ],
-  "scripts": {
-    "build": "tsc",
-    "test": "pnpm run test:unit && pnpm run test:type && pnpm run test:format",
-    "test:unit": "vitest run",
-    "test:type": "tsc --noEmit",
-    "test:format": "biome ci",
-    "prepublishOnly": "pnpm run build"
-  },
   "dependencies": {
-    "@clack/prompts": "^0.11.0",
+    "@clack/prompts": "^1.0.1",
+    "giget": "^3.1.2",
     "mri": "^1.2.0"
   },
   "devDependencies": {
-    "@types/node": "^25.0.3",
     "typescript": "^5.9.3",
-    "vitest": "^2.1.9"
+    "vitest": "^4.0.18"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "pnpm run test:unit && pnpm run test:type && pnpm run test:format",
+    "test:unit": "vitest run",
+    "test:type": "tsc --noEmit",
+    "test:format": "biome ci"
   }
-}
+}

package/template/AGENTS.md

@@ -0,0 +1 @@
+Before writing code, first explore the project structure, then invoke the chatgpt-app-builder skill for documentation.

package/template/README.md

@@ -1,116 +1,99 @@
-# ChatGPT Apps SDK Alpic Starter
+# Skybridge Starter
 
-This repository is a minimal Typescript application demonstrating how to build an OpenAI Apps SDK compatible MCP server with widget rendering in ChatGPT.
-
-![Demo](docs/demo.gif)
-
-## Overview
-
-This project shows how to integrate a Typescript express application with the ChatGPT Apps SDK using the Model Context Protocol (MCP). It includes a working MCP server that exposes tools and resources that can be called from ChatGPT, with responses rendered natively in ChatGPT. It also includes MCP tools without UI widgets.
+A minimal TypeScript template for building MCP and ChatGPT Apps with the [Skybridge](https://docs.skybridge.tech/home) framework.
 
 ## Getting Started
 
 ### Prerequisites
 
-- Node.js 22+ (see `.nvmrc` for exact version)
-- pnpm (install with `npm install -g pnpm`)
-- Ngrok
+- Node.js 24+
+- HTTP tunnel such as [ngrok](https://ngrok.com/download) if you want to test with remote MCP hosts like ChatGPT or Claude.ai.
 
-### Local Development with Hot Module Replacement (HMR)
-
-This project uses Vite for React widget development with full HMR support, allowing you to see changes in real-time, directly within ChatGPT conversation, without restarting the server.
+### Local Development
 
 #### 1. Install
 
 ```bash
+npm install
+# or
+yarn install
+# or
 pnpm install
+# or
+bun install
 ```
 
-#### 2. Start the Development Server
+#### 2. Start your local server
 
 Run the development server from the root directory:
 
 ```bash
+npm run dev
+# or
+yarn dev
+# or
 pnpm dev
+# or
+bun dev
 ```
 
-This command starts an Express server on port 3000. This server packages:
-
-- an MCP endpoint on `/mcp` - aka the ChatGPT App Backend
-- a React application on Vite HMR dev server - aka the ChatGPT App Frontend
+This command starts:
+- Your MCP server at `http://localhost:3000/mcp`.
+- Skybridge DevTools UI at `http://localhost:3000/`.
 
-#### 3. Expose Your Local Server
+#### 3. Project structure
 
-In a separate terminal, expose your local server using ngrok:
-
-```bash
-ngrok http 3000
 ```
-
-Copy the forwarding URL from ngrok output:
-
-```bash
-Forwarding     https://3785c5ddc4b6.ngrok-free.app -> http://localhost:3000
+├── server/
+│   └── src/
+│       ├── index.ts      # Entry point
+│       ├── middleware.ts # MCP middleware
+│       └── server.ts     # Widget registry & routes
+├── web/
+│   ├── src/
+│   │   ├── widgets/      # React components (one per widget)
+│   │   ├── helpers.ts    # Shared utilities
+│   │   └── index.css     # Global styles
+│   └── vite.config.ts
+├── alpic.json            # Deployment config
+├── nodemon.json          # Dev server config
+└── package.json
 ```
 
-#### 4. Connect to ChatGPT
-
-- Enable **Settings → Connectors → Advanced → Developer mode** in the ChatGPT client
-- Navigate to **Settings → Connectors → Create**
-- Enter your ngrok URL with the `/mcp` path (e.g., `https://3785c5ddc4b6.ngrok-free.app/mcp`)
-- Click **Create**
-
-#### 5. Test Your Integration
+### Create your first widget
 
-- Start a new conversation in ChatGPT
-- Select your newly created connector using **the + button → Your connector**
-- Try prompting the model (e.g., "Show me pikachu details")
+#### 1. Add a new widget
 
-#### 6. Develop with HMR
+- Register a widget in `server/src/server.ts` with a unique name (e.g., `my-widget`) using [`registerWidget`](https://docs.skybridge.tech/api-reference/register-widget)
+- Create a matching React component at `web/src/widgets/my-widget.tsx`. **The file name must match the widget name exactly**.
 
-Now you can edit React components in `web` and see changes instantly:
+#### 2. Edit widgets with Hot Module Replacement (HMR)
 
-- Make changes to any component
-- Save the file
-- The widget will automatically update in ChatGPT without refreshing or reconnecting
-- The Express server and MCP server continue running without interruption
+Edit and save components in `web/src/widgets/` — changes will appear instantly inside your App.
 
-**Note:** When you modify widget components, changes will be reflected immediately. If you modify MCP server code (in `src/`), you may need to reload your connector in **Settings → Connectors → [Your connector] → Reload**.
+#### 3. Edit server code
 
-## Widget Naming Convention
+Modify files in `server/` and refresh the connection with your testing MCP Client to see the changes.
 
-**Important:** For a widget to work properly, the name of the endpoint in your MCP server must match the file name of the corresponding React component in `web/src/widgets/`.
+### Testing your App
 
-For example:
+You can test your App locally by using our DevTools UI on `localhost:3000` while running the `pnpm dev` command.
 
-- If you create a widget endpoint named `pokemon-card`, you must create a corresponding React component file at `web/src/widgets/pokemon-card.tsx`
-- The endpoint name and the widget file name (without the `.tsx` extension) must be identical
+To test your app with other MCP Clients like ChatGPT, Claude or VSCode, see [Testing Your App](https://docs.skybridge.tech/quickstart/test-your-app).
 
-This naming convention allows the system to automatically map widget requests to their corresponding React components.
 
 ## Deploy to Production
 
-Use Alpic to deploy your OpenAI App to production.
-
-[![Deploy on Alpic](https://assets.alpic.ai/button.svg)](https://app.alpic.ai/new/clone?repositoryUrl=https%3A%2F%2Fgithub.com%2Falpic-ai%2Fapps-sdk-template)
-
-- In ChatGPT, navigate to **Settings → Connectors → Create** and add your MCP server URL (e.g., `https://your-app-name.alpic.live`)
+Skybridge is infrastructure vendor agnostic, and your app can be deployed on any cloud platform supporting MCP.
 
-## Project Structure
-
-```
-.
-├── server/
-│   ├── app.ts          # OpenAI App extension class with widget API implementation
-│   ├── server.ts       # MCP server with tool/resource/prompt registration
-│   └── index.ts        # Express server definition
-└── web/
-    └── src/
-        └── widgets/    # React widget components (must match endpoint names)
-```
+The simplest way to deploy your App in minutes is [Alpic](https://alpic.ai/).
+1. Create an account on [Alpic platform](https://app.alpic.ai/). 
+2. Connect your GitHub repository to automatically deploy at each commit. 
+3. Use your remote App URL to connect it to MCP Clients, or use the Alpic Playground to easily test your App.
 
 ## Resources
-
+- [Skybridge Documentation](https://docs.skybridge.tech/)
 - [Apps SDK Documentation](https://developers.openai.com/apps-sdk)
+- [MCP Apps Documentation](https://github.com/modelcontextprotocol/ext-apps/tree/main)
 - [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
 - [Alpic Documentation](https://docs.alpic.ai/)