create-skybridge 0.0.0-dev.ff50fdb → 0.0.1-cloudflare

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -3,6 +3,7 @@ import fs from "node:fs";
3
3
  import path from "node:path";
4
4
  import { fileURLToPath } from "node:url";
5
5
  import * as prompts from "@clack/prompts";
6
+ import { downloadTemplate } from "giget";
6
7
  import mri from "mri";
7
8
  const defaultProjectName = "skybridge-project";
8
9
  // prettier-ignore
@@ -13,21 +14,30 @@ Create a new Skybridge project by copying the starter template.
13
14
 
14
15
  Options:
15
16
  -h, --help show this help message
17
+ --repo <uri> use a git repository instead of the built-in template
16
18
  --overwrite remove existing files in target directory
17
19
  --immediate install dependencies and start development server
18
20
 
21
+ Repository URI formats:
22
+ github:user/repo
23
+ gitlab:user/repo/subdirectory
24
+ bitbucket:user/repo#branch
25
+
19
26
  Examples:
20
27
  create-skybridge my-app
28
+ create-skybridge my-app --repo github:alpic-ai/skybridge/examples/ecom-carousel
21
29
  create-skybridge . --overwrite --immediate
22
30
  `;
23
31
  export async function init(args = process.argv.slice(2)) {
24
32
  const argv = mri(args, {
25
33
  boolean: ["help", "overwrite", "immediate"],
34
+ string: ["repo"],
26
35
  alias: { h: "help" },
27
36
  });
28
37
  const argTargetDir = argv._[0]
29
38
  ? sanitizeTargetDir(String(argv._[0]))
30
39
  : undefined;
40
+ const argRepo = argv.repo;
31
41
  const argOverwrite = argv.overwrite;
32
42
  const argImmediate = argv.immediate;
33
43
  const help = argv.help;
@@ -46,7 +56,7 @@ export async function init(args = process.argv.slice(2)) {
46
56
  defaultValue: defaultProjectName,
47
57
  placeholder: defaultProjectName,
48
58
  validate: (value) => {
49
- return value.length === 0 || sanitizeTargetDir(value).length > 0
59
+ return !value || sanitizeTargetDir(value).length > 0
50
60
  ? undefined
51
61
  : "Invalid project name";
52
62
  },
@@ -95,38 +105,77 @@ export async function init(args = process.argv.slice(2)) {
95
105
  emptyDir(targetDir);
96
106
  break;
97
107
  case "no":
98
- cancel();
99
- return;
108
+ prompts.log.error("Target directory is not empty.");
109
+ process.exit(1);
100
110
  }
101
111
  }
102
112
  const root = path.join(process.cwd(), targetDir);
103
- // 3. Copy the repository
104
- prompts.log.step(`Copying template...`);
113
+ // 3. Download from repo or copy template
105
114
  try {
106
- const templateDir = fileURLToPath(new URL("../template", import.meta.url));
107
- // Copy template to target directory
108
- fs.cpSync(templateDir, root, {
109
- recursive: true,
110
- filter: (src) => [".npmrc"].every((file) => !src.endsWith(file)),
111
- });
112
- // Rename _gitignore to .gitignore
113
- fs.renameSync(path.join(root, "_gitignore"), path.join(root, ".gitignore"));
114
- // Update project name in package.json
115
- const name = path.basename(root);
116
- const pkgPath = path.join(root, "package.json");
117
- const pkg = fs.readFileSync(pkgPath, "utf-8");
118
- const fixed = pkg.replace(/apps-sdk-template/g, name);
119
- fs.writeFileSync(pkgPath, fixed);
120
- prompts.log.success(`Project created in ${root}`);
115
+ if (argRepo) {
116
+ prompts.log.step(`Downloading ${argRepo}...`);
117
+ await downloadTemplate(argRepo, { dir: root });
118
+ prompts.log.success(`Project created in ${root}`);
119
+ }
120
+ else {
121
+ prompts.log.step(`Copying template...`);
122
+ const templateDir = fileURLToPath(new URL("../template", import.meta.url));
123
+ // Copy template to target directory
124
+ fs.cpSync(templateDir, root, {
125
+ recursive: true,
126
+ filter: (src) => [".npmrc"].every((file) => !src.endsWith(file)),
127
+ });
128
+ // Rename _gitignore to .gitignore
129
+ fs.renameSync(path.join(root, "_gitignore"), path.join(root, ".gitignore"));
130
+ prompts.log.success(`Project created in ${root}`);
131
+ }
132
+ }
133
+ catch (error) {
134
+ prompts.log.error("Failed to create project from template");
135
+ console.error(error);
136
+ process.exit(1);
137
+ }
138
+ // Update project name in package.json
139
+ const pkgPath = path.join(root, "package.json");
140
+ if (!fs.existsSync(pkgPath)) {
141
+ prompts.log.error("No package.json found in project");
142
+ process.exit(1);
143
+ }
144
+ try {
145
+ const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
146
+ pkg.name = path.basename(root);
147
+ fs.writeFileSync(pkgPath, `${JSON.stringify(pkg, null, 2)}\n`);
121
148
  }
122
149
  catch (error) {
123
- prompts.log.error("Failed to copy repository");
150
+ prompts.log.error("Failed to update project name in package.json");
124
151
  console.error(error);
125
152
  process.exit(1);
126
153
  }
127
154
  const userAgent = process.env.npm_config_user_agent;
128
155
  const pkgManager = userAgent?.split(" ")[0]?.split("/")[0] || "npm";
129
- // 4. Ask about immediate installation
156
+ // 4. Ask about skills installation
157
+ if (interactive) {
158
+ const skillsResult = await prompts.confirm({
159
+ message: "Install the coding agents skills? (recommended)",
160
+ initialValue: true,
161
+ });
162
+ if (prompts.isCancel(skillsResult)) {
163
+ return cancel();
164
+ }
165
+ if (skillsResult) {
166
+ run([
167
+ ...getPkgExecCmd(pkgManager, "skills"),
168
+ "add",
169
+ "alpic-ai/skybridge",
170
+ "-s",
171
+ "chatgpt-app-builder",
172
+ ], {
173
+ stdio: "inherit",
174
+ cwd: targetDir,
175
+ });
176
+ }
177
+ }
178
+ // 5. Ask about immediate installation
130
179
  let immediate = argImmediate;
131
180
  if (immediate === undefined) {
132
181
  if (interactive) {
@@ -198,18 +247,37 @@ function sanitizeTargetDir(targetDir) {
198
247
  // Remove leading/trailing slashes
199
248
  .replace(/^\/+|\/+$/g, ""));
200
249
  }
201
- function isEmpty(path) {
202
- const files = fs.readdirSync(path);
203
- return files.length === 0 || (files.length === 1 && files[0] === ".git");
250
+ // Skip user's SPEC.md and IDE/agent preferences (.idea, .claude, etc.)
251
+ function isSkippedEntry(entry) {
252
+ return ((entry.name.startsWith(".") && entry.isDirectory()) ||
253
+ entry.name === "SPEC.md");
254
+ }
255
+ function isEmpty(dirPath) {
256
+ const entries = fs.readdirSync(dirPath, { withFileTypes: true });
257
+ return entries.every(isSkippedEntry);
204
258
  }
205
259
  function emptyDir(dir) {
206
260
  if (!fs.existsSync(dir)) {
207
261
  return;
208
262
  }
209
- for (const file of fs.readdirSync(dir)) {
210
- if (file === ".git") {
263
+ for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
264
+ if (isSkippedEntry(entry)) {
211
265
  continue;
212
266
  }
213
- fs.rmSync(path.resolve(dir, file), { recursive: true, force: true });
267
+ fs.rmSync(path.join(dir, entry.name), { recursive: true, force: true });
268
+ }
269
+ }
270
+ function getPkgExecCmd(pkgManager, cmd) {
271
+ switch (pkgManager) {
272
+ case "yarn":
273
+ return ["yarn", "dlx", cmd];
274
+ case "pnpm":
275
+ return ["pnpm", "dlx", cmd];
276
+ case "bun":
277
+ return ["bunx", cmd];
278
+ case "deno":
279
+ return ["deno", "run", "-A", `npm:${cmd}`];
280
+ default:
281
+ return ["npx", cmd];
214
282
  }
215
283
  }
@@ -14,10 +14,20 @@ describe("create-skybridge", () => {
14
14
  force: true,
15
15
  });
16
16
  });
17
- it("should scaffold a new project", async () => {
17
+ it("should copy the template", async () => {
18
18
  const name = `../../${tempDirName}//project$`;
19
19
  await init([name]);
20
20
  await fs.access(path.join(process.cwd(), tempDirName, "project", ".gitignore"));
21
21
  expect(fs.access(path.join(process.cwd(), tempDirName, "project", ".npmrc"))).rejects.toThrowError();
22
22
  });
23
+ it("should download template from repo", async () => {
24
+ const name = `../../${tempDirName}//project$`;
25
+ await init([
26
+ name,
27
+ "--repo",
28
+ "github:alpic-ai/skybridge/examples/ecom-carousel",
29
+ ]);
30
+ await fs.access(path.join(process.cwd(), tempDirName, "project", ".gitignore"));
31
+ expect(fs.access(path.join(process.cwd(), tempDirName, "project", ".npmrc"))).rejects.toThrowError();
32
+ });
23
33
  });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-skybridge",
3
- "version": "0.0.0-dev.ff50fdb",
3
+ "version": "0.0.1-cloudflare",
4
4
  "type": "module",
5
5
  "license": "MIT",
6
6
  "author": "Alpic",
@@ -16,19 +16,21 @@
16
16
  "dist",
17
17
  "template"
18
18
  ],
19
- "dependencies": {
20
- "@clack/prompts": "^0.11.0",
21
- "mri": "^1.2.0"
22
- },
23
- "devDependencies": {
24
- "typescript": "^5.9.3",
25
- "vitest": "^4.0.17"
26
- },
27
19
  "scripts": {
28
20
  "build": "tsc",
29
21
  "test": "pnpm run test:unit && pnpm run test:type && pnpm run test:format",
30
22
  "test:unit": "vitest run",
31
23
  "test:type": "tsc --noEmit",
32
- "test:format": "biome ci"
24
+ "test:format": "biome ci",
25
+ "prepublishOnly": "pnpm run build"
26
+ },
27
+ "dependencies": {
28
+ "@clack/prompts": "^1.1.0",
29
+ "giget": "^3.1.2",
30
+ "mri": "^1.2.0"
31
+ },
32
+ "devDependencies": {
33
+ "typescript": "^5.9.3",
34
+ "vitest": "^4.1.0"
33
35
  }
34
- }
36
+ }
@@ -0,0 +1 @@
1
+ Before writing code, first explore the project structure, then invoke the chatgpt-app-builder skill for documentation.
@@ -1,13 +1,13 @@
1
1
  # Skybridge Starter
2
2
 
3
- A minimal TypeScript template for building ChatGPT and MCP Apps with widget rendering.
3
+ A minimal TypeScript template for building MCP and ChatGPT Apps with the [Skybridge](https://docs.skybridge.tech/home) framework.
4
4
 
5
5
  ## Getting Started
6
6
 
7
7
  ### Prerequisites
8
8
 
9
9
  - Node.js 24+
10
- - HTTP tunnel such as [ngrok](https://ngrok.com/download)
10
+ - HTTP tunnel such as [ngrok](https://ngrok.com/download) if you want to test with remote MCP hosts like ChatGPT or Claude.ai.
11
11
 
12
12
  ### Local Development
13
13
 
@@ -37,41 +37,61 @@ pnpm dev
37
37
  bun dev
38
38
  ```
39
39
 
40
- This command starts an Express server on port 3000. This server packages:
40
+ This command starts:
41
+ - Your MCP server at `http://localhost:3000/mcp`.
42
+ - Skybridge DevTools UI at `http://localhost:3000/`.
41
43
 
42
- - an MCP endpoint on `/mcp` (the app backend)
43
- - a React application on Vite HMR dev server (the UI elements to be displayed in the host)
44
+ #### 3. Project structure
44
45
 
45
- #### 3. Connect to ChatGPT
46
-
47
- - ChatGPT requires connectors to be publicly accessible. To expose your server on the Internet, run:
48
- ```bash
49
- ngrok http 3000
50
46
  ```
51
- - In ChatGPT, navigate to **Settings → Connectors → Create** and add the forwarding URL provided by ngrok suffixed with `/mcp` (e.g. `https://3785c5ddc4b6.ngrok-free.app/mcp`)
47
+ ├── server/
48
+ │ └── src/
49
+ │ └── index.ts # Server entry point
50
+ ├── web/
51
+ │ ├── src/
52
+ │ │ ├── widgets/ # React components (one per widget)
53
+ │ │ ├── helpers.ts # Shared utilities
54
+ │ │ └── index.css # Global styles
55
+ │ └── vite.config.ts
56
+ ├── alpic.json # Deployment config
57
+ ├── nodemon.json # Dev server config
58
+ └── package.json
59
+ ```
52
60
 
53
61
  ### Create your first widget
54
62
 
55
63
  #### 1. Add a new widget
56
64
 
57
- - Register a widget in `server/server.ts` with a unique name (e.g., `my-widget`)
58
- - Create a matching React component at `web/src/widgets/my-widget.tsx`. The file name must match the widget name exactly
65
+ - 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)
66
+ - Create a matching React component at `web/src/widgets/my-widget.tsx`. **The file name must match the widget name exactly**.
59
67
 
60
68
  #### 2. Edit widgets with Hot Module Replacement (HMR)
61
69
 
62
- Edit and save components in `web/src/widgets/` — changes appear instantly in the host
70
+ Edit and save components in `web/src/widgets/` — changes will appear instantly inside your App.
63
71
 
64
72
  #### 3. Edit server code
65
73
 
66
- Modify files in `server/` and reload your ChatGPT connector in **Settings Connectors [Your connector] → Reload**
74
+ Modify files in `server/` and refresh the connection with your testing MCP Client to see the changes.
75
+
76
+ ### Testing your App
77
+
78
+ You can test your App locally by using our DevTools UI on `localhost:3000` while running the `pnpm dev` command.
79
+
80
+ 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).
81
+
67
82
 
68
83
  ## Deploy to Production
69
84
 
70
- - Use [Alpic](https://alpic.ai/) to deploy your OpenAI App to production
71
- - In ChatGPT, navigate to **Settings → Connectors → Create** and add your MCP server URL (e.g., `https://your-app-name.alpic.live`)
85
+ Skybridge is infrastructure vendor agnostic, and your app can be deployed on any cloud platform supporting MCP.
72
86
 
73
- ## Resources
87
+ The simplest way to deploy your App in minutes is [Alpic](https://alpic.ai/).
88
+ 1. Create an account on [Alpic platform](https://app.alpic.ai/).
89
+ 2. Connect your GitHub repository to automatically deploy at each commit.
90
+ 3. Use your remote App URL to connect it to MCP Clients, or use the Alpic Playground to easily test your App.
74
91
 
92
+ ## Resources
93
+ - [Skybridge Documentation](https://docs.skybridge.tech/)
75
94
  - [Apps SDK Documentation](https://developers.openai.com/apps-sdk)
95
+ - [MCP Apps Documentation](https://github.com/modelcontextprotocol/ext-apps/tree/main)
76
96
  - [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
77
97
  - [Alpic Documentation](https://docs.alpic.ai/)
@@ -0,0 +1,2 @@
1
+ /assets/*
2
+ Access-Control-Allow-Origin: *
@@ -8,32 +8,29 @@
8
8
  "dev": "skybridge dev",
9
9
  "build": "skybridge build",
10
10
  "start": "skybridge start",
11
- "inspector": "mcp-inspector http://localhost:3000/mcp"
11
+ "cloudflare:dev": "skybridge build && cp _headers dist/ && wrangler dev",
12
+ "cloudflare:deploy": "skybridge build && cp _headers dist/ && wrangler deploy",
13
+ "deploy": "alpic deploy"
12
14
  },
13
15
  "dependencies": {
14
- "@modelcontextprotocol/sdk": "^1.25.3",
15
- "cors": "^2.8.5",
16
- "express": "^5.2.1",
17
- "react": "^19.2.3",
18
- "react-dom": "^19.2.3",
19
- "skybridge": ">=0.25.0 <1.0.0",
20
- "vite": "^7.3.1",
21
- "zod": "^4.3.5"
16
+ "@modelcontextprotocol/sdk": "^1.27.1",
17
+ "react": "^19.2.4",
18
+ "react-dom": "^19.2.4",
19
+ "skybridge": "0.0.0-dev.ef94389",
20
+ "vite": "^8.0.0",
21
+ "zod": "^4.3.6"
22
22
  },
23
23
  "devDependencies": {
24
- "@modelcontextprotocol/inspector": "^0.18.0",
25
- "@skybridge/devtools": ">=0.22.0 <1.0.0",
26
- "@types/cors": "^2.8.19",
27
- "@types/express": "^5.0.6",
28
- "@types/react": "^19.2.9",
24
+ "@skybridge/devtools": "0.0.0-dev.ef94389",
25
+ "@types/react": "^19.2.14",
29
26
  "@types/react-dom": "^19.2.3",
30
- "@vitejs/plugin-react": "^5.1.2",
31
- "nodemon": "^3.1.11",
32
- "shx": "^0.4.0",
27
+ "@vitejs/plugin-react": "^6.0.1",
28
+ "alpic": "^1.96.1",
33
29
  "tsx": "^4.21.0",
34
- "typescript": "^5.9.3"
30
+ "typescript": "^5.9.3",
31
+ "wrangler": "^4.75.0"
35
32
  },
36
33
  "engines": {
37
- "node": ">=24.13.0"
34
+ "node": ">=24.14.0"
38
35
  }
39
36
  }
@@ -1,42 +1,67 @@
1
- import path from "node:path";
2
- import { fileURLToPath } from "node:url";
3
- import cors from "cors";
4
- import express, { type Express } from "express";
5
- import { widgetsDevServer } from "skybridge/server";
6
- import type { ViteDevServer } from "vite";
7
- import { mcp } from "./middleware.js";
8
- import server from "./server.js";
1
+ import { McpServer } from "skybridge/server";
2
+ import { z } from "zod";
9
3
 
10
- const app = express() as Express & { vite: ViteDevServer };
4
+ const Answers = [
5
+ "As I see it, yes",
6
+ "Don't count on it",
7
+ "It is certain",
8
+ "It is decidedly so",
9
+ "Most likely",
10
+ "My reply is no",
11
+ "My sources say no",
12
+ "Outlook good",
13
+ "Outlook not so good",
14
+ "Signs point to yes",
15
+ "Very doubtful",
16
+ "Without a doubt",
17
+ "Yes definitely",
18
+ "Yes",
19
+ "You may rely on it",
20
+ ];
11
21
 
12
- app.use(express.json());
22
+ const server = new McpServer(
23
+ {
24
+ name: "alpic-openai-app",
25
+ version: "0.0.1",
26
+ },
27
+ { capabilities: {} },
28
+ ).registerWidget(
29
+ "magic-8-ball",
30
+ {
31
+ description: "Magic 8 Ball",
32
+ },
33
+ {
34
+ description: "For fortune-telling or seeking advice.",
35
+ inputSchema: {
36
+ question: z.string().describe("The user question."),
37
+ },
38
+ },
39
+ async ({ question }) => {
40
+ try {
41
+ // deterministic answer
42
+ const hash = question
43
+ .split("")
44
+ .reduce((acc, char) => acc + char.charCodeAt(0), 0);
45
+ const answer = Answers[hash % Answers.length];
46
+ return {
47
+ structuredContent: { answer },
48
+ content: [],
49
+ isError: false,
50
+ };
51
+ } catch (error) {
52
+ return {
53
+ content: [{ type: "text", text: `Error: ${error}` }],
54
+ isError: true,
55
+ };
56
+ }
57
+ },
58
+ );
13
59
 
14
- app.use(mcp(server));
60
+ try {
61
+ const { default: manifest } = await import("./vite-manifest.js");
62
+ server.setViteManifest(manifest);
63
+ } catch {}
15
64
 
16
- const env = process.env.NODE_ENV || "development";
65
+ export default await server.run();
17
66
 
18
- if (env !== "production") {
19
- const { devtoolsStaticServer } = await import("@skybridge/devtools");
20
- app.use(await devtoolsStaticServer());
21
- app.use(await widgetsDevServer());
22
- }
23
-
24
- if (env === "production") {
25
- const __filename = fileURLToPath(import.meta.url);
26
- const __dirname = path.dirname(__filename);
27
-
28
- app.use("/assets", cors());
29
- app.use("/assets", express.static(path.join(__dirname, "assets")));
30
- }
31
-
32
- app.listen(3000, (error) => {
33
- if (error) {
34
- console.error("Failed to start server:", error);
35
- process.exit(1);
36
- }
37
- });
38
-
39
- process.on("SIGINT", async () => {
40
- console.log("Server shutdown complete");
41
- process.exit(0);
42
- });
67
+ export type AppType = typeof server;
@@ -0,0 +1,2 @@
1
+ declare const manifest: Record<string, { file: string }>;
2
+ export default manifest;
@@ -1,23 +1,9 @@
1
1
  {
2
- "compilerOptions": {
3
- "target": "ES2022",
4
- "module": "ESNext",
5
- "moduleResolution": "bundler",
6
- "lib": ["ES2022", "DOM", "DOM.Iterable"],
7
- "jsx": "react-jsx",
8
-
9
- "strict": true,
10
- "skipLibCheck": true,
11
- "esModuleInterop": true,
12
- "forceConsistentCasingInFileNames": true,
13
- "verbatimModuleSyntax": true,
14
-
15
- "noUnusedLocals": true,
16
- "noUnusedParameters": true,
17
- "noFallthroughCasesInSwitch": true,
2
+ "extends": "skybridge/tsconfig",
18
3
 
19
- "noEmit": true
4
+ "compilerOptions": {
5
+ "outDir": "dist"
20
6
  },
21
- "include": ["server/src", "web/src", "web/vite.config.ts"],
22
- "exclude": ["dist", "node_modules"]
7
+
8
+ "include": ["server/src", "web/src"]
23
9
  }
@@ -0,0 +1,24 @@
1
+ {
2
+ "../../../../node_modules/.pnpm/skybridge@0.0.0-dev.ef94389_@modelcontextprotocol+sdk@1.27.1_zod@4.3.6__@skybridge+devt_63f46c8326d3463146f1269d052398c5/node_modules/skybridge/dist/web/components/modal-provider.js": {
3
+ "file": "assets/modal-provider-4p4PW04T.js",
4
+ "name": "modal-provider",
5
+ "src": "../../../../node_modules/.pnpm/skybridge@0.0.0-dev.ef94389_@modelcontextprotocol+sdk@1.27.1_zod@4.3.6__@skybridge+devt_63f46c8326d3463146f1269d052398c5/node_modules/skybridge/dist/web/components/modal-provider.js",
6
+ "isDynamicEntry": true,
7
+ "imports": [
8
+ "src/widgets/magic-8-ball.tsx"
9
+ ]
10
+ },
11
+ "src/widgets/magic-8-ball.tsx": {
12
+ "file": "assets/magic-8-ball-DR3HjR06.js",
13
+ "name": "magic-8-ball",
14
+ "src": "src/widgets/magic-8-ball.tsx",
15
+ "isEntry": true,
16
+ "dynamicImports": [
17
+ "../../../../node_modules/.pnpm/skybridge@0.0.0-dev.ef94389_@modelcontextprotocol+sdk@1.27.1_zod@4.3.6__@skybridge+devt_63f46c8326d3463146f1269d052398c5/node_modules/skybridge/dist/web/components/modal-provider.js"
18
+ ]
19
+ },
20
+ "style.css": {
21
+ "file": "assets/style-CH_mzOKc.css",
22
+ "src": "style.css"
23
+ }
24
+ }