create-skybridge 0.0.0-dev.2 → 0.0.0-dev.2009590
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.d.ts +1 -0
- package/dist/index.js +389 -0
- package/index.js +6 -1
- package/package.json +15 -7
- package/templates/blank/.dockerignore +4 -0
- package/templates/blank/AGENTS.md +1 -0
- package/templates/blank/Dockerfile +53 -0
- package/templates/blank/README.md +92 -0
- package/templates/blank/_gitignore +7 -0
- package/templates/blank/alpic.json +3 -0
- package/templates/blank/node_modules/.bin/alpic +21 -0
- package/templates/blank/node_modules/.bin/sb +21 -0
- package/templates/blank/node_modules/.bin/skybridge +21 -0
- package/templates/blank/node_modules/.bin/tsc +21 -0
- package/templates/blank/node_modules/.bin/tsserver +21 -0
- package/templates/blank/node_modules/.bin/tsx +21 -0
- package/templates/blank/node_modules/.bin/vite +21 -0
- package/templates/blank/package.json +29 -0
- package/templates/blank/src/helpers.ts +4 -0
- package/templates/blank/src/server.ts +16 -0
- package/templates/blank/tsconfig.json +5 -0
- package/templates/blank/vite.config.ts +6 -0
- package/templates/demo/.dockerignore +4 -0
- package/templates/demo/AGENTS.md +1 -0
- package/templates/demo/Dockerfile +53 -0
- package/templates/demo/README.md +95 -0
- package/templates/demo/_gitignore +7 -0
- package/templates/demo/alpic.json +3 -0
- package/templates/demo/node_modules/.bin/alpic +21 -0
- package/templates/demo/node_modules/.bin/sb +21 -0
- package/templates/demo/node_modules/.bin/skybridge +21 -0
- package/templates/demo/node_modules/.bin/tsc +21 -0
- package/templates/demo/node_modules/.bin/tsserver +21 -0
- package/templates/demo/node_modules/.bin/tsx +21 -0
- package/templates/demo/node_modules/.bin/vite +21 -0
- package/templates/demo/package.json +41 -0
- package/templates/demo/src/helpers.ts +4 -0
- package/templates/demo/src/index.css +59 -0
- package/templates/demo/src/server.ts +94 -0
- package/templates/demo/src/views/components/doc-link.tsx +22 -0
- package/templates/demo/src/views/components/doc.tsx +21 -0
- package/templates/demo/src/views/components/nav.tsx +31 -0
- package/templates/demo/src/views/components/progress.tsx +35 -0
- package/templates/demo/src/views/components/steps/outro.tsx +68 -0
- package/templates/demo/src/views/components/steps/state.tsx +47 -0
- package/templates/demo/src/views/components/steps/tool-call.tsx +53 -0
- package/templates/demo/src/views/components/steps/tool-output.tsx +40 -0
- package/templates/demo/src/views/images/mascot/beret.png +0 -0
- package/templates/demo/src/views/images/mascot/chapka.png +0 -0
- package/templates/demo/src/views/images/mascot/cowboy-hat.png +0 -0
- package/templates/demo/src/views/images/mascot/fez.png +0 -0
- package/templates/demo/src/views/images/mascot/jester-hat.png +0 -0
- package/templates/demo/src/views/images/mascot/mitre.png +0 -0
- package/templates/demo/src/views/images/mascot/non-la.png +0 -0
- package/templates/demo/src/views/images/mascot/original.png +0 -0
- package/templates/demo/src/views/images/mascot/propeller-beanie.png +0 -0
- package/templates/demo/src/views/images/mascot/ski-mask.png +0 -0
- package/templates/demo/src/views/images/mascot/sombrero.png +0 -0
- package/templates/demo/src/views/images/mascot/top-hat.png +0 -0
- package/templates/demo/src/views/images/mascot/viking-helmet.png +0 -0
- package/templates/demo/src/views/onboarding.tsx +63 -0
- package/templates/demo/src/views/use-mascot.ts +60 -0
- package/templates/demo/tsconfig.json +11 -0
- package/templates/demo/vite.config.ts +14 -0
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function init(args?: string[]): Promise<void>;
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,389 @@
|
|
|
1
|
+
import fs from "node:fs";
|
|
2
|
+
import path from "node:path";
|
|
3
|
+
import { fileURLToPath } from "node:url";
|
|
4
|
+
import * as prompts from "@clack/prompts";
|
|
5
|
+
import spawn from "cross-spawn";
|
|
6
|
+
import mri from "mri";
|
|
7
|
+
const OUTPUT_TAIL_LINES = 10;
|
|
8
|
+
const DEFAULT_PROJECT_NAME = "skybridge-project";
|
|
9
|
+
const PACKAGE_MANAGERS = ["bun", "deno", "npm", "pnpm", "yarn"];
|
|
10
|
+
const TEMPLATES = ["demo", "blank"];
|
|
11
|
+
const pkg = JSON.parse(fs.readFileSync(fileURLToPath(new URL("../package.json", import.meta.url)), "utf-8"));
|
|
12
|
+
const version = pkg.version;
|
|
13
|
+
const HELP_MESSAGE = `Usage: skybridge create [path] [options]
|
|
14
|
+
|
|
15
|
+
⛰ Skybridge v${version} - the fullstack framework for building MCP Apps
|
|
16
|
+
|
|
17
|
+
Arguments:
|
|
18
|
+
path Where the project will be created. Prompted when omitted.
|
|
19
|
+
|
|
20
|
+
Options:
|
|
21
|
+
--blank scaffold a minimal project without demo tools and views
|
|
22
|
+
--overwrite remove existing files if target directory is not empty
|
|
23
|
+
--pm <choice> package manager to use (choices: ${PACKAGE_MANAGERS.join(", ")}. default to npm when none is provided or infered)
|
|
24
|
+
--skip-skills skip installing coding agent skills
|
|
25
|
+
--start start dev server
|
|
26
|
+
--yes skip prompts and use default values for unprovided options
|
|
27
|
+
--help display this help message
|
|
28
|
+
|
|
29
|
+
Non-interactive usage:
|
|
30
|
+
Mandatory: path argument and --yes option
|
|
31
|
+
Example: skybridge create my-app --yes`;
|
|
32
|
+
const isTTY = process.stdout.isTTY;
|
|
33
|
+
const _spinner = prompts.spinner();
|
|
34
|
+
const Spinner = {
|
|
35
|
+
start(msg) {
|
|
36
|
+
if (!isTTY) {
|
|
37
|
+
prompts.log.info(msg);
|
|
38
|
+
}
|
|
39
|
+
else {
|
|
40
|
+
_spinner.clear();
|
|
41
|
+
_spinner.start(msg);
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
stop(msg) {
|
|
45
|
+
if (!isTTY) {
|
|
46
|
+
prompts.log.success(msg);
|
|
47
|
+
}
|
|
48
|
+
else {
|
|
49
|
+
_spinner.stop(msg);
|
|
50
|
+
}
|
|
51
|
+
},
|
|
52
|
+
error(msg) {
|
|
53
|
+
if (!isTTY) {
|
|
54
|
+
prompts.log.error(msg);
|
|
55
|
+
}
|
|
56
|
+
else {
|
|
57
|
+
_spinner.error(msg);
|
|
58
|
+
}
|
|
59
|
+
},
|
|
60
|
+
};
|
|
61
|
+
export async function init(args = process.argv.slice(2)) {
|
|
62
|
+
const argv = mri(args, {
|
|
63
|
+
boolean: ["help", "blank", "overwrite", "skip-skills", "start", "yes"],
|
|
64
|
+
string: ["pm"],
|
|
65
|
+
alias: { h: "help" },
|
|
66
|
+
});
|
|
67
|
+
if (argv.help) {
|
|
68
|
+
console.log(HELP_MESSAGE);
|
|
69
|
+
return;
|
|
70
|
+
}
|
|
71
|
+
const { yes } = argv;
|
|
72
|
+
let targetDir = argv._[0] ? sanitizeTargetDir(String(argv._[0])) : undefined;
|
|
73
|
+
if (yes && !targetDir) {
|
|
74
|
+
abort("The target directory is required in non-interactive mode.", "Example: skybridge create my-app --yes");
|
|
75
|
+
}
|
|
76
|
+
let pm = parsePackageManager(argv.pm || "");
|
|
77
|
+
if (argv.pm && !pm) {
|
|
78
|
+
abort(`Invalid --pm value "${argv.pm}". Expected one of: ${PACKAGE_MANAGERS.join(", ")}.`);
|
|
79
|
+
}
|
|
80
|
+
console.log(); // cosmetic line break
|
|
81
|
+
prompts.intro(`\x1b[1;36m⛰ Welcome to Skybridge v${version} \x1b[22m- the fullstack framework for building MCP Apps\x1b[0m`);
|
|
82
|
+
// 1. Target directory
|
|
83
|
+
if (!targetDir) {
|
|
84
|
+
const choice = await prompts.text({
|
|
85
|
+
message: "Project directory:",
|
|
86
|
+
placeholder: DEFAULT_PROJECT_NAME,
|
|
87
|
+
defaultValue: DEFAULT_PROJECT_NAME,
|
|
88
|
+
validate: (value) => !value || sanitizeTargetDir(value).length > 0
|
|
89
|
+
? undefined
|
|
90
|
+
: "Invalid project name",
|
|
91
|
+
});
|
|
92
|
+
if (prompts.isCancel(choice)) {
|
|
93
|
+
return cancel();
|
|
94
|
+
}
|
|
95
|
+
targetDir = sanitizeTargetDir(choice);
|
|
96
|
+
}
|
|
97
|
+
// 2. Existing-directory handling
|
|
98
|
+
if (fs.existsSync(targetDir) && !isEmpty(targetDir)) {
|
|
99
|
+
if (argv.overwrite) {
|
|
100
|
+
emptyDir(targetDir);
|
|
101
|
+
}
|
|
102
|
+
else if (yes) {
|
|
103
|
+
prompts.log.error(`Target directory "${targetDir}" is not empty. Use --overwrite to remove existing files.`);
|
|
104
|
+
process.exit(1);
|
|
105
|
+
}
|
|
106
|
+
else {
|
|
107
|
+
const ok = await prompts.confirm({
|
|
108
|
+
message: `Target directory "${targetDir}" is not empty. Remove existing files?`,
|
|
109
|
+
initialValue: true,
|
|
110
|
+
});
|
|
111
|
+
if (prompts.isCancel(ok) || !ok) {
|
|
112
|
+
return cancel();
|
|
113
|
+
}
|
|
114
|
+
Spinner.start(`Cleaning up ${targetDir}`);
|
|
115
|
+
emptyDir(targetDir);
|
|
116
|
+
Spinner.stop(`Cleaned up ${targetDir}`);
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
// 3. Template
|
|
120
|
+
let template;
|
|
121
|
+
if (argv.blank) {
|
|
122
|
+
template = "blank";
|
|
123
|
+
}
|
|
124
|
+
else if (yes) {
|
|
125
|
+
template = "demo";
|
|
126
|
+
}
|
|
127
|
+
else {
|
|
128
|
+
const choice = await prompts.select({
|
|
129
|
+
message: "Choose a template:",
|
|
130
|
+
options: [
|
|
131
|
+
{
|
|
132
|
+
value: "demo",
|
|
133
|
+
label: "demo",
|
|
134
|
+
hint: "starter code with tools and UI",
|
|
135
|
+
},
|
|
136
|
+
{
|
|
137
|
+
value: "blank",
|
|
138
|
+
label: "blank",
|
|
139
|
+
hint: "minimal boilerplate without tools",
|
|
140
|
+
},
|
|
141
|
+
],
|
|
142
|
+
initialValue: "demo",
|
|
143
|
+
});
|
|
144
|
+
if (prompts.isCancel(choice)) {
|
|
145
|
+
return cancel();
|
|
146
|
+
}
|
|
147
|
+
template = choice;
|
|
148
|
+
}
|
|
149
|
+
// 4. Copy template
|
|
150
|
+
const root = path.resolve(targetDir);
|
|
151
|
+
Spinner.start(`Copying ${template} template`);
|
|
152
|
+
try {
|
|
153
|
+
const templateDir = fileURLToPath(new URL(`../templates/${template}`, import.meta.url));
|
|
154
|
+
fs.cpSync(templateDir, root, {
|
|
155
|
+
recursive: true,
|
|
156
|
+
filter: (src) => [".npmrc"].every((file) => !src.endsWith(file)),
|
|
157
|
+
});
|
|
158
|
+
const gitignoreSource = path.join(root, "_gitignore");
|
|
159
|
+
if (fs.existsSync(gitignoreSource)) {
|
|
160
|
+
fs.renameSync(gitignoreSource, path.join(root, ".gitignore"));
|
|
161
|
+
}
|
|
162
|
+
Spinner.stop(`Copied ${template} template`);
|
|
163
|
+
}
|
|
164
|
+
catch (error) {
|
|
165
|
+
Spinner.error("Failed to copy template");
|
|
166
|
+
abort(String(error));
|
|
167
|
+
}
|
|
168
|
+
// 5. Set package.json name to the project dir basename
|
|
169
|
+
try {
|
|
170
|
+
const pkgPath = path.join(root, "package.json");
|
|
171
|
+
const projectPkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
|
|
172
|
+
projectPkg.name = path.basename(root);
|
|
173
|
+
fs.writeFileSync(pkgPath, `${JSON.stringify(projectPkg, null, 2)}\n`);
|
|
174
|
+
}
|
|
175
|
+
catch (error) {
|
|
176
|
+
abort("Failed to update project name in package.json.", String(error));
|
|
177
|
+
}
|
|
178
|
+
// Async spawn wrapper so a spinner can keep animating during the subprocess
|
|
179
|
+
// (cross-spawn.sync would block the event loop). Captures stdout/stderr to
|
|
180
|
+
// `output` when stdio is "pipe", trimmed to the last OUTPUT_TAIL_LINES lines
|
|
181
|
+
// — install errors land at the tail, so we keep that and prefix with an
|
|
182
|
+
// ellipsis when content gets dropped.
|
|
183
|
+
function spawnAsync(command, args) {
|
|
184
|
+
return new Promise((resolve) => {
|
|
185
|
+
let raw = "";
|
|
186
|
+
const child = spawn(command, args, {
|
|
187
|
+
stdio: ["ignore", "pipe", "pipe"],
|
|
188
|
+
cwd: root,
|
|
189
|
+
});
|
|
190
|
+
child.stdout?.on("data", (chunk) => {
|
|
191
|
+
raw += chunk.toString();
|
|
192
|
+
});
|
|
193
|
+
child.stderr?.on("data", (chunk) => {
|
|
194
|
+
raw += chunk.toString();
|
|
195
|
+
});
|
|
196
|
+
const done = (status) => {
|
|
197
|
+
const tail = [];
|
|
198
|
+
for (const part of raw.split("\n").reverse()) {
|
|
199
|
+
const line = part.trim();
|
|
200
|
+
if (!line) {
|
|
201
|
+
continue;
|
|
202
|
+
}
|
|
203
|
+
if (tail.length >= OUTPUT_TAIL_LINES) {
|
|
204
|
+
tail.push(`… (truncated, showing last ${OUTPUT_TAIL_LINES} lines)`);
|
|
205
|
+
break;
|
|
206
|
+
}
|
|
207
|
+
tail.push(line);
|
|
208
|
+
}
|
|
209
|
+
resolve({ status, output: tail.reverse().join("\n") });
|
|
210
|
+
};
|
|
211
|
+
child.on("close", done);
|
|
212
|
+
child.on("error", () => done(1));
|
|
213
|
+
});
|
|
214
|
+
}
|
|
215
|
+
// 6. Skills install (single Y/n prompt)
|
|
216
|
+
let installSkills;
|
|
217
|
+
if (argv["skip-skills"]) {
|
|
218
|
+
installSkills = false;
|
|
219
|
+
}
|
|
220
|
+
else if (yes) {
|
|
221
|
+
installSkills = true;
|
|
222
|
+
}
|
|
223
|
+
else {
|
|
224
|
+
const choice = await prompts.confirm({
|
|
225
|
+
message: "Install coding agent skills? (recommended)",
|
|
226
|
+
initialValue: true,
|
|
227
|
+
});
|
|
228
|
+
if (prompts.isCancel(choice)) {
|
|
229
|
+
return cancel();
|
|
230
|
+
}
|
|
231
|
+
installSkills = choice;
|
|
232
|
+
}
|
|
233
|
+
if (installSkills) {
|
|
234
|
+
Spinner.start("Installing coding agent skills");
|
|
235
|
+
const { status, output } = await spawnAsync("npx", [
|
|
236
|
+
"--yes",
|
|
237
|
+
"skills",
|
|
238
|
+
"add",
|
|
239
|
+
"alpic-ai/skybridge",
|
|
240
|
+
"--skill",
|
|
241
|
+
"chatgpt-app-builder",
|
|
242
|
+
"--agent",
|
|
243
|
+
"universal",
|
|
244
|
+
"claude-code",
|
|
245
|
+
"--copy", // something the symlink fails for some reason
|
|
246
|
+
"--yes",
|
|
247
|
+
]);
|
|
248
|
+
// skills cli always returns 0 so we look for the success message
|
|
249
|
+
if (status === 0 && output.includes("Done!")) {
|
|
250
|
+
Spinner.stop(`Installed coding agent skills`);
|
|
251
|
+
}
|
|
252
|
+
else {
|
|
253
|
+
Spinner.error(`Failed to install coding agent skills:
|
|
254
|
+
\x1b[2m${output}\x1b[0m`);
|
|
255
|
+
prompts.log.error("Try manually: `npx skills add alpic-ai/skybridge`.");
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
// 7. Package manager — autodetect, prompt only if detection fails (interactive)
|
|
259
|
+
if (!pm) {
|
|
260
|
+
pm = detectPackageManager() || "npm";
|
|
261
|
+
}
|
|
262
|
+
if (!yes) {
|
|
263
|
+
const choice = await prompts.select({
|
|
264
|
+
message: "Choose a package manager:",
|
|
265
|
+
options: PACKAGE_MANAGERS.map((value) => ({ value })),
|
|
266
|
+
initialValue: pm,
|
|
267
|
+
});
|
|
268
|
+
if (prompts.isCancel(choice)) {
|
|
269
|
+
return cancel();
|
|
270
|
+
}
|
|
271
|
+
pm = choice;
|
|
272
|
+
}
|
|
273
|
+
// 8. Always install dependencies
|
|
274
|
+
Spinner.start(`Installing dependencies with ${pm}`);
|
|
275
|
+
const { status, output } = await spawnAsync(pm, ["install"]);
|
|
276
|
+
if (status === 0) {
|
|
277
|
+
Spinner.stop(`Installed dependencies with ${pm}`);
|
|
278
|
+
}
|
|
279
|
+
else {
|
|
280
|
+
Spinner.error(`Dependency installation failed:
|
|
281
|
+
\x1b[2m${output}\x1b[0m`);
|
|
282
|
+
abort(`Try manually: cd ${targetDir} && ${pm} install`);
|
|
283
|
+
}
|
|
284
|
+
// 9. Start dev server?
|
|
285
|
+
let start = false;
|
|
286
|
+
if (argv.start) {
|
|
287
|
+
start = true;
|
|
288
|
+
}
|
|
289
|
+
else if (!yes) {
|
|
290
|
+
const choice = await prompts.confirm({
|
|
291
|
+
message: "Start dev server now?",
|
|
292
|
+
initialValue: true,
|
|
293
|
+
});
|
|
294
|
+
if (prompts.isCancel(choice)) {
|
|
295
|
+
return cancel();
|
|
296
|
+
}
|
|
297
|
+
start = choice;
|
|
298
|
+
}
|
|
299
|
+
if (start) {
|
|
300
|
+
prompts.outro(`Starting dev server in ${targetDir}…`);
|
|
301
|
+
const devResult = spawn.sync(pm, scriptArgs(pm, "dev"), {
|
|
302
|
+
stdio: "inherit",
|
|
303
|
+
cwd: root,
|
|
304
|
+
});
|
|
305
|
+
process.exit(devResult.status ?? 0);
|
|
306
|
+
}
|
|
307
|
+
prompts.log.success("All set! Next steps:");
|
|
308
|
+
prompts.log.info(`Start:
|
|
309
|
+
cd ${targetDir}
|
|
310
|
+
${scriptCommand(pm, "dev")}`);
|
|
311
|
+
prompts.log.info(`Deploy:
|
|
312
|
+
${scriptCommand(pm, "deploy")}`);
|
|
313
|
+
prompts.outro(`🛟 Need help?
|
|
314
|
+
Chat: https://discord.alpic.ai
|
|
315
|
+
Docs: https://docs.skybridge.tech`);
|
|
316
|
+
}
|
|
317
|
+
function cancel() {
|
|
318
|
+
prompts.cancel("Operation cancelled");
|
|
319
|
+
process.exit(0);
|
|
320
|
+
}
|
|
321
|
+
function abort(...lines) {
|
|
322
|
+
for (const line of lines) {
|
|
323
|
+
prompts.log.error(line);
|
|
324
|
+
}
|
|
325
|
+
prompts.outro("Aborted");
|
|
326
|
+
process.exit(1);
|
|
327
|
+
}
|
|
328
|
+
function parsePackageManager(value) {
|
|
329
|
+
switch (value) {
|
|
330
|
+
case "bun":
|
|
331
|
+
return "bun";
|
|
332
|
+
case "deno":
|
|
333
|
+
return "deno";
|
|
334
|
+
case "npm":
|
|
335
|
+
return "npm";
|
|
336
|
+
case "pnpm":
|
|
337
|
+
return "pnpm";
|
|
338
|
+
case "yarn":
|
|
339
|
+
return "yarn";
|
|
340
|
+
default:
|
|
341
|
+
return undefined;
|
|
342
|
+
}
|
|
343
|
+
}
|
|
344
|
+
function detectPackageManager() {
|
|
345
|
+
const userAgent = process.env.npm_config_user_agent;
|
|
346
|
+
if (!userAgent) {
|
|
347
|
+
return undefined;
|
|
348
|
+
}
|
|
349
|
+
const name = userAgent.split(" ")[0]?.split("/")[0];
|
|
350
|
+
return parsePackageManager(name);
|
|
351
|
+
}
|
|
352
|
+
function scriptArgs(pm, script) {
|
|
353
|
+
switch (pm) {
|
|
354
|
+
case "yarn":
|
|
355
|
+
case "pnpm":
|
|
356
|
+
case "bun":
|
|
357
|
+
return [script];
|
|
358
|
+
case "deno":
|
|
359
|
+
return ["task", script];
|
|
360
|
+
case "npm":
|
|
361
|
+
return ["run", script];
|
|
362
|
+
}
|
|
363
|
+
}
|
|
364
|
+
function scriptCommand(pm, script) {
|
|
365
|
+
return [pm, ...scriptArgs(pm, script)].join(" ");
|
|
366
|
+
}
|
|
367
|
+
function sanitizeTargetDir(targetDir) {
|
|
368
|
+
return targetDir.trim().replace(/\/+$/g, "");
|
|
369
|
+
}
|
|
370
|
+
// Skip user's SPEC.md and IDE/agent preferences (.idea, .claude, etc.)
|
|
371
|
+
function isSkippedEntry(entry) {
|
|
372
|
+
return ((entry.name.startsWith(".") && entry.isDirectory()) ||
|
|
373
|
+
entry.name === "SPEC.md");
|
|
374
|
+
}
|
|
375
|
+
function isEmpty(dirPath) {
|
|
376
|
+
const entries = fs.readdirSync(dirPath, { withFileTypes: true });
|
|
377
|
+
return entries.every(isSkippedEntry);
|
|
378
|
+
}
|
|
379
|
+
function emptyDir(dir) {
|
|
380
|
+
if (!fs.existsSync(dir)) {
|
|
381
|
+
return;
|
|
382
|
+
}
|
|
383
|
+
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
|
|
384
|
+
if (isSkippedEntry(entry)) {
|
|
385
|
+
continue;
|
|
386
|
+
}
|
|
387
|
+
fs.rmSync(path.join(dir, entry.name), { recursive: true, force: true });
|
|
388
|
+
}
|
|
389
|
+
}
|
package/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,28 +1,36 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-skybridge",
|
|
3
|
-
"version": "0.0.0-dev.
|
|
3
|
+
"version": "0.0.0-dev.2009590",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Alpic",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "https://github.com/alpic-ai/skybridge.git"
|
|
10
|
+
},
|
|
7
11
|
"bin": {
|
|
8
12
|
"create-skybridge": "index.js"
|
|
9
13
|
},
|
|
10
14
|
"files": [
|
|
11
15
|
"index.js",
|
|
12
|
-
"dist"
|
|
16
|
+
"dist",
|
|
17
|
+
"templates"
|
|
13
18
|
],
|
|
14
19
|
"dependencies": {
|
|
15
|
-
"@clack/prompts": "^
|
|
20
|
+
"@clack/prompts": "^1.1.0",
|
|
21
|
+
"cross-spawn": "^7.0.6",
|
|
16
22
|
"mri": "^1.2.0"
|
|
17
23
|
},
|
|
18
24
|
"devDependencies": {
|
|
19
|
-
"@types/
|
|
20
|
-
"
|
|
21
|
-
"
|
|
25
|
+
"@types/cross-spawn": "^6.0.6",
|
|
26
|
+
"typescript": "^6.0.2",
|
|
27
|
+
"vitest": "^4.1.4"
|
|
22
28
|
},
|
|
23
29
|
"scripts": {
|
|
24
30
|
"build": "tsc",
|
|
25
|
-
"test
|
|
31
|
+
"test": "pnpm run test:unit && pnpm run test:format",
|
|
32
|
+
"test:unit": "vitest run",
|
|
33
|
+
"format": "biome check --write --error-on-warnings",
|
|
26
34
|
"test:format": "biome ci"
|
|
27
35
|
}
|
|
28
36
|
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
This is a ChatGPT/MCP app built with Skybridge. ALWAYS use the `chatgpt-app-builder` skill when planning or updating the codebase.
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# syntax=docker/dockerfile:1
|
|
2
|
+
|
|
3
|
+
# Dockerfile for a Skybridge MCP server.
|
|
4
|
+
#
|
|
5
|
+
# Detects npm, yarn, or pnpm from the lockfile in your project.
|
|
6
|
+
# (For bun or deno, adapt the install/build/prune commands below.)
|
|
7
|
+
|
|
8
|
+
# Build stage: install deps, compile the app, then prune dev deps.
|
|
9
|
+
FROM node:24-slim AS build
|
|
10
|
+
WORKDIR /app
|
|
11
|
+
|
|
12
|
+
COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* .npmrc* ./
|
|
13
|
+
RUN --mount=type=cache,target=/root/.npm \
|
|
14
|
+
--mount=type=cache,target=/usr/local/share/.cache/yarn \
|
|
15
|
+
--mount=type=cache,target=/root/.local/share/pnpm/store \
|
|
16
|
+
if [ -f package-lock.json ]; then \
|
|
17
|
+
npm ci; \
|
|
18
|
+
elif [ -f yarn.lock ]; then \
|
|
19
|
+
corepack enable yarn && yarn install --frozen-lockfile; \
|
|
20
|
+
elif [ -f pnpm-lock.yaml ]; then \
|
|
21
|
+
corepack enable pnpm && pnpm install --frozen-lockfile; \
|
|
22
|
+
else \
|
|
23
|
+
echo "No lockfile found." && exit 1; \
|
|
24
|
+
fi
|
|
25
|
+
|
|
26
|
+
ENV NODE_ENV=production
|
|
27
|
+
|
|
28
|
+
COPY . .
|
|
29
|
+
RUN if [ -f package-lock.json ]; then \
|
|
30
|
+
npm run build && npm prune --omit=dev; \
|
|
31
|
+
elif [ -f yarn.lock ]; then \
|
|
32
|
+
corepack enable yarn && yarn build && yarn install --frozen-lockfile --production=true; \
|
|
33
|
+
elif [ -f pnpm-lock.yaml ]; then \
|
|
34
|
+
corepack enable pnpm && pnpm build && pnpm prune --prod; \
|
|
35
|
+
fi
|
|
36
|
+
|
|
37
|
+
# Runtime stage: copy built artifacts and prod deps, run as non-root.
|
|
38
|
+
FROM node:24-slim AS runtime
|
|
39
|
+
WORKDIR /app
|
|
40
|
+
ENV NODE_ENV=production
|
|
41
|
+
|
|
42
|
+
USER node
|
|
43
|
+
|
|
44
|
+
COPY --from=build --chown=node:node /app/node_modules ./node_modules
|
|
45
|
+
COPY --from=build --chown=node:node /app/dist ./dist
|
|
46
|
+
COPY --from=build --chown=node:node /app/package.json ./package.json
|
|
47
|
+
|
|
48
|
+
EXPOSE 3000
|
|
49
|
+
|
|
50
|
+
# Run the built server directly rather than via `npm start` / `skybridge start`.
|
|
51
|
+
# Each wrapper adds a process layer that can swallow SIGTERM, which makes
|
|
52
|
+
# graceful shutdowns time out on platforms like Cloud Run, Fly, and k8s.
|
|
53
|
+
CMD ["node", "dist/__entry.js"]
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# Skybridge Boilerplate
|
|
2
|
+
|
|
3
|
+
A minimal TypeScript boilerplate for building MCP and ChatGPT Apps with the [Skybridge](https://docs.skybridge.tech) framework.
|
|
4
|
+
|
|
5
|
+
## Getting Started
|
|
6
|
+
|
|
7
|
+
### Prerequisites
|
|
8
|
+
|
|
9
|
+
- Node.js 24+
|
|
10
|
+
|
|
11
|
+
### Local Development
|
|
12
|
+
|
|
13
|
+
#### 1. Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install
|
|
17
|
+
# or
|
|
18
|
+
pnpm install
|
|
19
|
+
# or
|
|
20
|
+
bun install
|
|
21
|
+
# or
|
|
22
|
+
deno install
|
|
23
|
+
# or
|
|
24
|
+
yarn install
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
#### 2. Start your local server
|
|
28
|
+
|
|
29
|
+
Run the development server from the root directory:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npm run dev
|
|
33
|
+
# or
|
|
34
|
+
pnpm dev
|
|
35
|
+
# or
|
|
36
|
+
bun dev
|
|
37
|
+
# or
|
|
38
|
+
deno task dev
|
|
39
|
+
# or
|
|
40
|
+
yarn dev
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
This command starts:
|
|
44
|
+
- Your MCP server at `http://localhost:3000/mcp`.
|
|
45
|
+
- Skybridge DevTools UI at `http://localhost:3000`.
|
|
46
|
+
|
|
47
|
+
#### 3. Project structure
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
├── src/
|
|
51
|
+
│ ├── server.ts # Server entry point
|
|
52
|
+
│ └── helpers.ts # Shared utilities
|
|
53
|
+
├── vite.config.ts
|
|
54
|
+
├── alpic.json # Deployment config
|
|
55
|
+
└── package.json
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Create your first view
|
|
59
|
+
|
|
60
|
+
#### 1. Add a new view
|
|
61
|
+
|
|
62
|
+
- Register a tool in `src/server.ts` with a unique name (e.g., `my-view`) using [`registerTool`](https://docs.skybridge.tech/api-reference/register-tool) and a `view` config.
|
|
63
|
+
- Create a matching React component at `src/views/my-view.tsx`. **The file name must match the view name exactly**.
|
|
64
|
+
|
|
65
|
+
#### 2. Edit views with Hot Module Replacement (HMR)
|
|
66
|
+
|
|
67
|
+
Edit and save components in `src/views/` — changes will appear instantly inside your App.
|
|
68
|
+
|
|
69
|
+
#### 3. Edit server code
|
|
70
|
+
|
|
71
|
+
Modify files in `src/` and refresh the tool list with your MCP Client to see the changes.
|
|
72
|
+
|
|
73
|
+
### Testing your App
|
|
74
|
+
|
|
75
|
+
You can test your app locally by using our DevTools UI on `http://localhost:3000` while running the `dev` command.
|
|
76
|
+
|
|
77
|
+
To connect your app with web clients like ChatGPT or Claude, expose your server on the internet by adding the `--tunnel` flag.
|
|
78
|
+
By enabling the tunnel, you'll also be able to access a playground to chat with your app and a real LLM. Learn more by reading the [test guide](https://docs.skybridge.tech/quickstart/test-your-app).
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
## Deploy to Production
|
|
82
|
+
|
|
83
|
+
Skybridge is infrastructure vendor agnostic, and your app can be deployed on any cloud platform supporting MCP.
|
|
84
|
+
|
|
85
|
+
The simplest way to deploy your app is by running the `deploy` command, which will push your MCP server to the [Alpic](https://alpic.ai/) cloud for free.
|
|
86
|
+
|
|
87
|
+
## Resources
|
|
88
|
+
- [Skybridge Documentation](https://docs.skybridge.tech/)
|
|
89
|
+
- [Apps SDK Documentation](https://developers.openai.com/apps-sdk)
|
|
90
|
+
- [MCP Apps Documentation](https://github.com/modelcontextprotocol/ext-apps/tree/main)
|
|
91
|
+
- [Model Context Protocol Documentation](https://modelcontextprotocol.io/)
|
|
92
|
+
- [Alpic Documentation](https://docs.alpic.ai/)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
3
|
+
|
|
4
|
+
case `uname` in
|
|
5
|
+
*CYGWIN*|*MINGW*|*MSYS*)
|
|
6
|
+
if command -v cygpath > /dev/null 2>&1; then
|
|
7
|
+
basedir=`cygpath -w "$basedir"`
|
|
8
|
+
fi
|
|
9
|
+
;;
|
|
10
|
+
esac
|
|
11
|
+
|
|
12
|
+
if [ -z "$NODE_PATH" ]; then
|
|
13
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.136.3_@opentelemetry+api@1.9.1_arktype@2.1.27_rxjs@7.8.2_typescript@6.0.2/node_modules/alpic/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.136.3_@opentelemetry+api@1.9.1_arktype@2.1.27_rxjs@7.8.2_typescript@6.0.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
|
|
14
|
+
else
|
|
15
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.136.3_@opentelemetry+api@1.9.1_arktype@2.1.27_rxjs@7.8.2_typescript@6.0.2/node_modules/alpic/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/alpic@1.136.3_@opentelemetry+api@1.9.1_arktype@2.1.27_rxjs@7.8.2_typescript@6.0.2/node_modules:/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
|
|
16
|
+
fi
|
|
17
|
+
if [ -x "$basedir/node" ]; then
|
|
18
|
+
exec "$basedir/node" "$basedir/../alpic/bin/run.js" "$@"
|
|
19
|
+
else
|
|
20
|
+
exec node "$basedir/../alpic/bin/run.js" "$@"
|
|
21
|
+
fi
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
3
|
+
|
|
4
|
+
case `uname` in
|
|
5
|
+
*CYGWIN*|*MINGW*|*MSYS*)
|
|
6
|
+
if command -v cygpath > /dev/null 2>&1; then
|
|
7
|
+
basedir=`cygpath -w "$basedir"`
|
|
8
|
+
fi
|
|
9
|
+
;;
|
|
10
|
+
esac
|
|
11
|
+
|
|
12
|
+
if [ -z "$NODE_PATH" ]; then
|
|
13
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
|
|
14
|
+
else
|
|
15
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
|
|
16
|
+
fi
|
|
17
|
+
if [ -x "$basedir/node" ]; then
|
|
18
|
+
exec "$basedir/node" "$basedir/../skybridge/bin/run.js" "$@"
|
|
19
|
+
else
|
|
20
|
+
exec node "$basedir/../skybridge/bin/run.js" "$@"
|
|
21
|
+
fi
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
#!/bin/sh
|
|
2
|
+
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
|
3
|
+
|
|
4
|
+
case `uname` in
|
|
5
|
+
*CYGWIN*|*MINGW*|*MSYS*)
|
|
6
|
+
if command -v cygpath > /dev/null 2>&1; then
|
|
7
|
+
basedir=`cygpath -w "$basedir"`
|
|
8
|
+
fi
|
|
9
|
+
;;
|
|
10
|
+
esac
|
|
11
|
+
|
|
12
|
+
if [ -z "$NODE_PATH" ]; then
|
|
13
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules"
|
|
14
|
+
else
|
|
15
|
+
export NODE_PATH="/home/runner/work/skybridge/skybridge/node_modules/.pnpm/node_modules:$NODE_PATH"
|
|
16
|
+
fi
|
|
17
|
+
if [ -x "$basedir/node" ]; then
|
|
18
|
+
exec "$basedir/node" "$basedir/../skybridge/bin/run.js" "$@"
|
|
19
|
+
else
|
|
20
|
+
exec node "$basedir/../skybridge/bin/run.js" "$@"
|
|
21
|
+
fi
|