vercel-vm-factory 0.5.8 → 0.7.8

package/README.md

@@ -1,10 +1,11 @@
 # Vercel VM Factory
 
-Create a tiny Vercel Container deployment: copy `wsterm` from `ghcr.io/v1xingyue/ws-shell:v1.8.alpine` into a selected base image, then deploy with Vercel CLI.
+Create a tiny Vercel Container deployment: copy `wsterm` from `ghcr.io/v1xingyue/ws-shell:v1.8.alpine` into a selected VM image, then deploy with Vercel CLI.
 
 ```bash
 npx vercel-vm-factory create \
-  --base ubuntu \
+  --vm-image ubuntu \
+  --shell /bin/bash \
   --project ws-shell-ubuntu \
   --auth-mode basic \
   --auth-user admin \
@@ -50,16 +51,22 @@ CLI mapping:
 - Application Preset -> patched through Vercel API as `framework=container`
 - Root Directory -> generated project directory
 
-Base presets:
+VM image presets:
 
 - `alpine` -> `alpine:3.23`
 - `ubuntu` -> `ubuntu:24.04`
 - `debian` -> `debian:13-slim`
 
-Custom base:
+Shell options:
+
+- `/bin/bash`
+- `/bin/zsh`
+- `/bin/sh`
+
+Custom VM image:
 
 ```bash
-npx vercel-vm-factory create --base fedora:42 --project ws-shell-fedora
+npx vercel-vm-factory create --vm-image fedora:42 --project ws-shell-fedora
 ```
 
 Before deploying, set the GitHub OAuth callback URL to:

package/deploy-vm.mjs

@@ -8,11 +8,12 @@ import path from "node:path";
 
 const defaultWsShellImage = "ghcr.io/v1xingyue/ws-shell:v1.8.alpine";
 
-const bases = {
+const vmImages = {
   alpine: "alpine:3.23",
   ubuntu: "ubuntu:24.04",
   debian: "debian:13-slim",
 };
+const shells = ["/bin/bash", "/bin/zsh", "/bin/sh"];
 
 const { command, args } = parseCommand(process.argv.slice(2));
 const scriptRoot = path.resolve(import.meta.dirname);
@@ -20,7 +21,11 @@ const workspaceRoot = process.cwd();
 const stateRoot = path.join(homedir(), ".vercel-vm-factory");
 const defaultsPath = path.join(stateRoot, "defaults.json");
 const legacyDefaultsPath = path.join(scriptRoot, ".defaults.json");
-const codeDefaults = { base: "alpine", from: defaultWsShellImage };
+const codeDefaults = {
+  "vm-image": "alpine",
+  from: defaultWsShellImage,
+  shell: "/bin/sh",
+};
 const packagedDefaults = {
   ...(await readDefaults(legacyDefaultsPath)),
   ...codeDefaults,
@@ -71,8 +76,10 @@ async function main() {
     return;
   }
 
-  const baseName = await chooseBase(args.base ?? defaults.base ?? "alpine");
-  const baseImage = bases[baseName] ?? baseName;
+  const vmImageName = await chooseVmImage(
+    args["vm-image"] ?? args.base ?? defaults["vm-image"] ?? "alpine",
+  );
+  const vmImage = vmImages[vmImageName] ?? vmImageName;
   const scope = await optionalValue(
     "scope",
     "Vercel team/scope",
@@ -81,13 +88,14 @@ async function main() {
   const project = await value(
     "project",
     "Vercel project name",
-    defaults.project ?? `ws-shell-${baseName}`,
+    defaults.project ?? `ws-shell-${vmImageName}`,
   );
   const wsShellImage =
     args.from ??
     process.env.WS_SHELL_IMAGE ??
     defaults.from ??
     defaultWsShellImage;
+  const shell = await chooseShell(args.shell ?? defaults.shell ?? "/bin/sh");
   const prod = args.prod !== "false";
   const dryRun = Boolean(args["dry-run"]);
   const skipLink = Boolean(args["skip-link"]);
@@ -105,17 +113,18 @@ async function main() {
     ".generated",
     project,
   );
-  const dockerfile = makeDockerfile({ baseImage, wsShellImage });
+  const dockerfile = makeDockerfile({ shell, vmImage, wsShellImage });
 
   await rm(appDir, { recursive: true, force: true });
   await mkdir(appDir, { recursive: true });
   await writeFile(path.join(appDir, "Dockerfile.vercel"), dockerfile);
 
   printSummary({
-    base: `${baseName} -> ${baseImage}`,
+    "vm image": `${vmImageName} -> ${vmImage}`,
     project,
     scope: scope || "default",
     source: wsShellImage,
+    shell,
     auth: authMode,
     ...(usesGitHubAuth(authMode) ? { callback: oauthRedirectUrl } : {}),
     dockerfile: path.join(appDir, "Dockerfile.vercel"),
@@ -167,10 +176,11 @@ async function main() {
 
   await writeDefaults(defaultsPath, {
     ...defaults,
-    base: baseName,
+    "vm-image": vmImageName,
     scope: scope || undefined,
     project,
     from: wsShellImage,
+    shell,
     "auth-mode": authMode,
     "auth-user": authUsername,
     "auth-password": authPassword,
@@ -270,15 +280,12 @@ async function installVercelCli() {
     );
 
   const install = await choosePackageInstall();
-  const rl = createInterface({ input, output });
   const answer = (
-    await rl.question(
-      `Vercel CLI is not installed. Install it with "${install.command} ${install.args.join(" ")}"? [y/N]: `,
+    await askText(
+      `Vercel CLI is not installed. Install with ${install.command} ${install.args.join(" ")}?`,
+      "N",
     )
-  )
-    .trim()
-    .toLowerCase();
-  rl.close();
+  ).toLowerCase();
 
   if (answer !== "y" && answer !== "yes")
     throw new Error("Vercel CLI is required. Exiting.");
@@ -313,10 +320,11 @@ async function doctor() {
   console.log("");
   console.log(color.bold("Saved defaults"));
   printKeyValue("defaults file", defaultsPath);
-  printKeyValue("base", defaults.base || "not set");
+  printKeyValue("vm image", defaults["vm-image"] || "not set");
   printKeyValue("project", defaults.project || "not set");
   printKeyValue("scope", defaults.scope || "not set");
   printKeyValue("source image", defaults.from || defaultWsShellImage);
+  printKeyValue("shell", defaults.shell || "/bin/sh");
   printKeyValue("auth mode", defaults["auth-mode"] || "not set");
   printKeyValue(
     "auth user",
@@ -340,12 +348,12 @@ async function doctor() {
   );
 }
 
-function makeDockerfile({ baseImage, wsShellImage }) {
+function makeDockerfile({ shell, vmImage, wsShellImage }) {
   return `ARG WS_SHELL_IMAGE=${wsShellImage}
-ARG BASE_IMAGE=${baseImage}
+ARG VM_IMAGE=${vmImage}
 
 FROM \${WS_SHELL_IMAGE} AS ws-shell
-FROM \${BASE_IMAGE} AS base
+FROM \${VM_IMAGE} AS vm
 
 # wsterm already embeds the web UI; runtime config comes from environment variables.
 COPY --from=ws-shell /app/bin/wsterm /app/bin/wsterm
@@ -353,7 +361,7 @@ COPY --from=ws-shell /app/bin/wsterm /app/bin/wsterm
 WORKDIR /app
 ENV ENABLE_SSL=false
 EXPOSE 80
-CMD ["/app/bin/wsterm","-bind",":80","-fork","/bin/sh"]
+CMD ["/app/bin/wsterm","-bind",":80","-fork","${shell}"]
 `;
 }
 
@@ -362,11 +370,7 @@ async function value(name, question, fallback) {
   if (args[name]) return args[name];
   if (!input.isTTY) return current || "";
 
-  const rl = createInterface({ input, output });
-  const answer = (
-    await rl.question(`${question}${fallback ? ` [${fallback}]` : ""}: `)
-  ).trim();
-  rl.close();
+  const answer = await askText(question, fallback);
   return answer || current || "";
 }
 
@@ -374,10 +378,8 @@ async function secret(name, question, fallback) {
   if (args[name]) return args[name];
   if (!input.isTTY) return fallback || "";
 
-  const rl = createInterface({ input, output });
   const placeholder = fallback ? mask(fallback) : "skip";
-  const answer = (await rl.question(`${question} [${placeholder}]: `)).trim();
-  rl.close();
+  const answer = await askText(question, placeholder);
   return answer || fallback || "";
 }
 
@@ -385,10 +387,10 @@ async function optionalValue(name, question, fallback) {
   if (args[name] !== undefined) return args[name];
   if (!input.isTTY) return "";
 
-  const rl = createInterface({ input, output });
-  const suffix = fallback ? ` [${fallback}; Enter to skip]` : " [skip]";
-  const answer = (await rl.question(`${question}${suffix}: `)).trim();
-  rl.close();
+  const answer = await askText(
+    question,
+    fallback ? `${fallback}; Enter to skip` : "skip",
+  );
   return answer;
 }
 
@@ -422,15 +424,14 @@ async function chooseAuthMode(fallback) {
   }
   if (!input.isTTY) return modes.has(fallback) ? fallback : "basic";
 
-  console.log(color.bold("Choose authentication"));
-  console.log(`  ${color.cyan("1")}. basic username/password`);
-  console.log(`  ${color.cyan("2")}. GitHub OAuth`);
-  console.log(`  ${color.cyan("3")}. both`);
-  console.log(`  ${color.cyan("4")}. none`);
+  printChoices("Authentication", [
+    ["1", "basic", "username/password"],
+    ["2", "github", "GitHub OAuth"],
+    ["3", "both", "basic + GitHub OAuth"],
+    ["4", "none", "no app auth"],
+  ]);
 
-  const rl = createInterface({ input, output });
-  const answer = (await rl.question(`Authentication [${fallback}]: `)).trim();
-  rl.close();
+  const answer = await askText("Authentication", fallback);
 
   if (!answer) return modes.has(fallback) ? fallback : "basic";
   if (modes.has(answer)) return answer;
@@ -449,28 +450,53 @@ function usesGitHubAuth(mode) {
   return mode === "github" || mode === "both";
 }
 
-async function chooseBase(fallback) {
+async function chooseVmImage(fallback) {
+  if (args["vm-image"]) return args["vm-image"];
   if (args.base) return args.base;
   if (!input.isTTY) return fallback;
 
-  const names = Object.keys(bases);
-  console.log(color.bold("Choose base image"));
-  names.forEach((name, index) =>
-    console.log(
-      `  ${color.cyan(String(index + 1))}. ${name} ${color.dim(`(${bases[name]})`)}`,
-    ),
+  const names = Object.keys(vmImages);
+  printChoices(
+    "VM image",
+    names.map((name, index) => [
+      String(index + 1),
+      name,
+      vmImages[name],
+    ]).concat([["4", "custom", "enter a full image name"]]),
   );
-  console.log(`  ${color.cyan("4")}. custom image`);
 
-  const rl = createInterface({ input, output });
-  const answer = (await rl.question(`Base [${fallback}]: `)).trim();
-  rl.close();
+  const answer = await askText("VM image", fallback);
 
   if (!answer) return fallback;
-  if (bases[answer]) return answer;
+  if (vmImages[answer]) return answer;
   if (/^[1-3]$/.test(answer)) return names[Number(answer) - 1];
   if (answer === "4")
-    return value("custom-base", "Custom base image", defaults["custom-base"]);
+    return value(
+      "custom-vm-image",
+      "Custom VM image",
+      defaults["custom-vm-image"],
+    );
+  return answer;
+}
+
+async function chooseShell(fallback) {
+  if (args.shell) return args.shell;
+  if (!input.isTTY) return fallback;
+
+  printChoices(
+    "Shell",
+    shells.map((shell, index) => [
+      String(index + 1),
+      shell,
+      index === shells.length - 1 ? "default" : "",
+    ]),
+  );
+
+  const answer = await askText("Shell", fallback);
+
+  if (!answer) return fallback;
+  if (shells.includes(answer)) return answer;
+  if (/^[1-3]$/.test(answer)) return shells[Number(answer) - 1];
   return answer;
 }
 
@@ -517,8 +543,16 @@ async function writeDefaults(file, data) {
 }
 
 function cleanDefaults(data) {
+  const migrated = {
+    ...data,
+    "vm-image": data["vm-image"] ?? data.base,
+    "custom-vm-image": data["custom-vm-image"] ?? data["custom-base"],
+  };
+  delete migrated.base;
+  delete migrated["custom-base"];
+
   const clean = Object.fromEntries(
-    Object.entries(data).filter(([, value]) => value),
+    Object.entries(migrated).filter(([, value]) => value),
   );
   return Object.fromEntries(
     Object.entries(clean).sort(([a], [b]) => a.localeCompare(b)),
@@ -623,18 +657,30 @@ function findLastUrl(text) {
 }
 
 function printHeader() {
-  console.log(color.bold(color.cyan("Vercel VM Factory")));
-  console.log(
-    color.dim("Build a Container deployment from a tiny Dockerfile.vercel"),
-  );
+  console.log("");
+  console.log(color.cyan(" __     ____  __   _____           _                   "));
+  console.log(color.cyan(" \\ \\   / /  \\/  | |  ___|_ _  ___| |_ ___  _ __ _   _ "));
+  console.log(color.cyan("  \\ \\ / /| |\\/| | | |_ / _` |/ __| __/ _ \\| '__| | | |"));
+  console.log(color.cyan("   \\ V / | |  | | |  _| (_| | (__| || (_) | |  | |_| |"));
+  console.log(color.cyan("    \\_/  |_|  |_| |_|  \\__,_|\\___|\\__\\___/|_|   \\__, |"));
+  console.log(color.cyan("                                                 |___/ "));
+  console.log(color.dim("        Vercel Container VM deployment helper"));
   console.log("");
 }
 
 function printSummary(items) {
+  const entries = Object.entries(items);
+  const keyWidth = Math.max(...entries.map(([key]) => key.length), 1);
+  const valueWidth = Math.max(...entries.map(([, value]) => String(value).length), 1);
+  const width = keyWidth + valueWidth + 5;
+
   console.log(color.bold("Deployment plan"));
+  console.log(color.cyan(`+${"-".repeat(width)}+`));
   for (const [key, value] of Object.entries(items)) {
-    printKeyValue(key, value);
+    const line = `${key.padEnd(keyWidth)}  ${String(value).padEnd(valueWidth)}`;
+    console.log(`${color.cyan("|")} ${line} ${color.cyan("|")}`);
   }
+  console.log(color.cyan(`+${"-".repeat(width)}+`));
   console.log("");
 }
 
@@ -661,6 +707,28 @@ function printKeyValue(key, value) {
   console.log(`${color.dim(`${key.padEnd(14)} `)}${value}`);
 }
 
+async function askText(question, fallback = "") {
+  const suffix = fallback ? color.dim(` [${fallback}]`) : "";
+  const rl = createInterface({ input, output });
+  const answer = (
+    await rl.question(
+      `${color.cyan("?")} ${color.bold(question)}${suffix}\n${color.dim("> ")} `,
+    )
+  ).trim();
+  rl.close();
+  return answer;
+}
+
+function printChoices(title, choices) {
+  console.log("");
+  console.log(color.bold(title));
+  for (const [key, label, detail] of choices) {
+    const hint = detail ? ` ${color.dim(detail)}` : "";
+    console.log(`  ${color.cyan(key)}  ${label}${hint}`);
+  }
+  console.log("");
+}
+
 function step(text) {
   console.log(`${color.cyan("->")} ${text}`);
 }
@@ -681,15 +749,17 @@ function printHelp() {
   printHeader();
   console.log(`Usage:
   vercel-vm-factory create
-  vercel-vm-factory create --base ubuntu --project x-shell
+  vercel-vm-factory create --vm-image ubuntu --project x-shell
   vercel-vm-factory doctor
   npx vercel-vm-factory create
 
 Options:
-  --base NAME          alpine, ubuntu, debian, or a custom image
+  --vm-image NAME      alpine, ubuntu, debian, or a custom VM image
+  --base NAME          Alias for --vm-image
   --project NAME       Vercel project name
   --scope SLUG         Optional Vercel team/user scope slug
   --from IMAGE         Source image for /app/bin/wsterm
+  --shell PATH         /bin/bash, /bin/zsh, or /bin/sh
   --auth-mode MODE     basic, github, both, or none
   --auth-user VALUE    Username/password auth user
   --auth-password VAL  Username/password auth password

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vercel-vm-factory",
-  "version": "0.5.8",
-  "description": "Create Vercel Container deployments for ws-shell from selectable base images.",
+  "version": "0.7.8",
+  "description": "Create Vercel Container deployments for ws-shell from selectable VM images.",
   "license": "MIT",
   "type": "module",
   "bin": {