vercel-vm-factory 0.1.1 → 0.1.3

package/README.md

@@ -6,6 +6,7 @@ Create a tiny Vercel Container deployment: copy `wsterm` from `ghcr.io/v1xingyue
 npx vercel-vm-factory create \
   --base ubuntu \
   --project ws-shell-ubuntu \
+  --auth-mode basic \
   --auth-user admin \
   --auth-password change-me
 ```
@@ -14,6 +15,7 @@ GitHub OAuth is optional:
 
 ```bash
 npx vercel-vm-factory create \
+  --auth-mode github \
   --client-id YOUR_GITHUB_CLIENT_ID \
   --client-secret YOUR_GITHUB_CLIENT_SECRET \
   --github-userid 12345678
@@ -25,6 +27,8 @@ Run without flags for prompts:
 npx vercel-vm-factory create
 ```
 
+The prompt asks for authentication first: `basic`, `github`, `both`, or `none`, then only asks for the fields that mode needs.
+
 Check local setup:
 
 ```bash
@@ -72,6 +76,7 @@ https://x-shell.vercel.app/auth/github/callback
 
 GitHub OAuth fields:
 
+- Auth mode -> `--auth-mode basic|github|both|none`
 - Username -> `--auth-user`
 - Password -> `--auth-password`
 - Client ID -> `--client-id`

package/deploy-vm.mjs

@@ -6,6 +6,8 @@ import { stdin as input, stdout as output } from "node:process";
 import { homedir } from "node:os";
 import path from "node:path";
 
+const defaultWsShellImage = "ghcr.io/v1xingyue/ws-shell:v1.2.alpine";
+
 const bases = {
   alpine: "alpine:3.23",
   ubuntu: "ubuntu:24.04",
@@ -18,7 +20,10 @@ 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 defaults = { ...(await readDefaults(legacyDefaultsPath)), ...(await readDefaults(defaultsPath)) };
+const defaults = {
+  ...(await readDefaults(legacyDefaultsPath)),
+  ...(await readDefaults(defaultsPath)),
+};
 const colorEnabled = output.isTTY && !process.env.NO_COLOR;
 const color = {
   dim: (text) => paint(text, "2"),
@@ -41,7 +46,9 @@ try {
 } catch (error) {
   const message = error instanceof Error ? error.message : String(error);
   if (message.includes("scope does not exist")) {
-    console.error(`\nScope not found. Leave scope empty, or set the real CLI slug with --scope.`);
+    console.error(
+      `\nScope not found. Leave scope empty, or set the real CLI slug with --scope.`,
+    );
     console.error(`If it was saved before, edit or delete: ${defaultsPath}`);
   }
   console.error(message);
@@ -58,12 +65,25 @@ async function main() {
 
   const baseName = await chooseBase(args.base ?? defaults.base ?? "alpine");
   const baseImage = bases[baseName] ?? baseName;
-  const scope = await optionalValue("scope", "Vercel team/scope", defaults.scope);
-  const project = await value("project", "Vercel project name", defaults.project ?? `ws-shell-${baseName}`);
-  const wsShellImage = args.from ?? process.env.WS_SHELL_IMAGE ?? defaults.from ?? "ghcr.io/v1xingyue/ws-shell:v1.1.alpine";
+  const scope = await optionalValue(
+    "scope",
+    "Vercel team/scope",
+    defaults.scope,
+  );
+  const project = await value(
+    "project",
+    "Vercel project name",
+    defaults.project ?? `ws-shell-${baseName}`,
+  );
+  const wsShellImage =
+    args.from ??
+    process.env.WS_SHELL_IMAGE ??
+    defaults.from ??
+    defaultWsShellImage;
   const prod = args.prod !== "false";
   const dryRun = Boolean(args["dry-run"]);
   const skipLink = Boolean(args["skip-link"]);
+  const authMode = await chooseAuthMode(defaultAuthMode());
 
   const oauthRedirectUrl =
     args["redirect-url"] ??
@@ -71,7 +91,12 @@ async function main() {
     defaults["redirect-url"] ??
     `https://${project}.vercel.app/auth/github/callback`;
 
-  const appDir = path.join(workspaceRoot, ".vercel-vm-factory", ".generated", project);
+  const appDir = path.join(
+    workspaceRoot,
+    ".vercel-vm-factory",
+    ".generated",
+    project,
+  );
   const dockerfile = makeDockerfile({ baseImage, wsShellImage });
 
   await rm(appDir, { recursive: true, force: true });
@@ -83,7 +108,8 @@ async function main() {
     project,
     scope: scope || "default",
     source: wsShellImage,
-    callback: oauthRedirectUrl,
+    auth: authMode,
+    ...(usesGitHubAuth(authMode) ? { callback: oauthRedirectUrl } : {}),
     dockerfile: path.join(appDir, "Dockerfile.vercel"),
     target: prod ? "production" : "preview",
   });
@@ -94,17 +120,43 @@ async function main() {
   }
 
   await ensureVercelReady();
-  printOAuthGuide(oauthRedirectUrl);
-
-  const authUsername = await secret("auth-user", "Basic auth username", process.env.AUTH_USERNAME ?? defaults["auth-user"]);
-  const authPassword = await secret("auth-password", "Basic auth password", process.env.AUTH_PASSWORD ?? defaults["auth-password"]);
-  const githubClientId = await secret("client-id", "GitHub client id", process.env.GITHUB_CLIENT_ID ?? defaults["client-id"]);
-  const githubClientSecret = await secret(
-    "client-secret",
-    "GitHub client secret",
-    process.env.GITHUB_CLIENT_SECRET ?? defaults["client-secret"],
-  );
-  const allowedUserIds = await secret("github-userid", "Allowed GitHub numeric user id(s)", process.env.ALLOWED_USER_IDS ?? defaults["github-userid"]);
+  if (usesGitHubAuth(authMode)) printOAuthGuide(oauthRedirectUrl);
+
+  const authUsername = usesBasicAuth(authMode)
+    ? await secret(
+        "auth-user",
+        "Basic auth username",
+        process.env.AUTH_USERNAME ?? defaults["auth-user"],
+      )
+    : "";
+  const authPassword = usesBasicAuth(authMode)
+    ? await secret(
+        "auth-password",
+        "Basic auth password",
+        process.env.AUTH_PASSWORD ?? defaults["auth-password"],
+      )
+    : "";
+  const githubClientId = usesGitHubAuth(authMode)
+    ? await secret(
+        "client-id",
+        "GitHub client id",
+        process.env.GITHUB_CLIENT_ID ?? defaults["client-id"],
+      )
+    : "";
+  const githubClientSecret = usesGitHubAuth(authMode)
+    ? await secret(
+        "client-secret",
+        "GitHub client secret",
+        process.env.GITHUB_CLIENT_SECRET ?? defaults["client-secret"],
+      )
+    : "";
+  const allowedUserIds = usesGitHubAuth(authMode)
+    ? await secret(
+        "github-userid",
+        "Allowed GitHub numeric user id(s)",
+        process.env.ALLOWED_USER_IDS ?? defaults["github-userid"],
+      )
+    : "";
 
   await writeDefaults(defaultsPath, {
     ...defaults,
@@ -112,6 +164,7 @@ async function main() {
     scope: scope || undefined,
     project,
     from: wsShellImage,
+    "auth-mode": authMode,
     "auth-user": authUsername,
     "auth-password": authPassword,
     "client-id": githubClientId,
@@ -125,7 +178,15 @@ async function main() {
 
   if (!skipLink) {
     step("Linking Vercel project");
-    await runNoUrl("vercel", ["link", "--yes", "--project", project, "--cwd", appDir, ...commonArgs]);
+    await runNoUrl("vercel", [
+      "link",
+      "--yes",
+      "--project",
+      project,
+      "--cwd",
+      appDir,
+      ...commonArgs,
+    ]);
   } else {
     warn("skip-link enabled; using existing .vercel/project.json");
   }
@@ -133,32 +194,33 @@ async function main() {
   step("Setting project framework=container");
   await setContainerFramework(appDir, commonArgs);
 
-  const vercelArgs = [
-    "deploy",
-    appDir,
-    "--yes",
-    "--logs",
-    "--env",
-    `OAUTH_REDIRECT_URL=${oauthRedirectUrl}`,
-  ];
+  const vercelArgs = ["deploy", appDir, "--yes", "--logs"];
 
   if (authUsername) vercelArgs.push("--env", `AUTH_USERNAME=${authUsername}`);
   if (authPassword) vercelArgs.push("--env", `AUTH_PASSWORD=${authPassword}`);
-  if (githubClientId) vercelArgs.push("--env", `GITHUB_CLIENT_ID=${githubClientId}`);
-  if (githubClientSecret) vercelArgs.push("--env", `GITHUB_CLIENT_SECRET=${githubClientSecret}`);
-  if (allowedUserIds) vercelArgs.push("--env", `ALLOWED_USER_IDS=${allowedUserIds}`);
+  if (usesGitHubAuth(authMode))
+    vercelArgs.push("--env", `OAUTH_REDIRECT_URL=${oauthRedirectUrl}`);
+  if (githubClientId)
+    vercelArgs.push("--env", `GITHUB_CLIENT_ID=${githubClientId}`);
+  if (githubClientSecret)
+    vercelArgs.push("--env", `GITHUB_CLIENT_SECRET=${githubClientSecret}`);
+  if (allowedUserIds)
+    vercelArgs.push("--env", `ALLOWED_USER_IDS=${allowedUserIds}`);
   if (prod) vercelArgs.push("--prod");
   vercelArgs.push(...commonArgs);
 
   step("Deploying");
   const deploymentUrl = await run("vercel", vercelArgs);
-  console.log(`\n${color.green("Deployment URL:")} ${color.bold(deploymentUrl)}`);
+  console.log(
+    `\n${color.green("Deployment URL:")} ${color.bold(deploymentUrl)}`,
+  );
 }
 
 async function setContainerFramework(appDir, commonArgs) {
   const projectFile = path.join(appDir, ".vercel", "project.json");
   const projectConfig = JSON.parse(await readFile(projectFile, "utf8"));
-  if (!projectConfig.projectId) throw new Error(`Missing projectId in ${projectFile}`);
+  if (!projectConfig.projectId)
+    throw new Error(`Missing projectId in ${projectFile}`);
 
   await runNoUrl("vercel", [
     "api",
@@ -177,7 +239,9 @@ async function ensureVercelReady() {
     const version = await runCapture("vercel", ["--version"]);
     ok(version.split("\n").filter(Boolean).at(-1) || "vercel installed");
   } catch {
-    throw new Error("Vercel CLI is not installed. Install it with: pnpm add -g vercel");
+    throw new Error(
+      "Vercel CLI is not installed. Install it with: pnpm add -g vercel",
+    );
   }
 
   step("Checking Vercel login");
@@ -198,12 +262,31 @@ async function doctor() {
   printKeyValue("base", defaults.base || "not set");
   printKeyValue("project", defaults.project || "not set");
   printKeyValue("scope", defaults.scope || "not set");
-  printKeyValue("source image", defaults.from || "ghcr.io/v1xingyue/ws-shell:v1.1.alpine");
-  printKeyValue("auth user", defaults["auth-user"] ? mask(defaults["auth-user"]) : "not set");
-  printKeyValue("auth password", defaults["auth-password"] ? mask(defaults["auth-password"]) : "not set");
-  printKeyValue("client id", defaults["client-id"] ? mask(defaults["client-id"]) : "not set");
-  printKeyValue("client secret", defaults["client-secret"] ? mask(defaults["client-secret"]) : "not set");
-  printKeyValue("github userid", defaults["github-userid"] ? mask(defaults["github-userid"]) : "not set");
+  printKeyValue(
+    "source image",
+    defaults.from || "ghcr.io/v1xingyue/ws-shell:v1.1.alpine",
+  );
+  printKeyValue("auth mode", defaults["auth-mode"] || "not set");
+  printKeyValue(
+    "auth user",
+    defaults["auth-user"] ? mask(defaults["auth-user"]) : "not set",
+  );
+  printKeyValue(
+    "auth password",
+    defaults["auth-password"] ? mask(defaults["auth-password"]) : "not set",
+  );
+  printKeyValue(
+    "client id",
+    defaults["client-id"] ? mask(defaults["client-id"]) : "not set",
+  );
+  printKeyValue(
+    "client secret",
+    defaults["client-secret"] ? mask(defaults["client-secret"]) : "not set",
+  );
+  printKeyValue(
+    "github userid",
+    defaults["github-userid"] ? mask(defaults["github-userid"]) : "not set",
+  );
 }
 
 function makeDockerfile({ baseImage, wsShellImage }) {
@@ -229,7 +312,9 @@ async function value(name, question, fallback) {
   if (!input.isTTY) return current || "";
 
   const rl = createInterface({ input, output });
-  const answer = (await rl.question(`${question}${fallback ? ` [${fallback}]` : ""}: `)).trim();
+  const answer = (
+    await rl.question(`${question}${fallback ? ` [${fallback}]` : ""}: `)
+  ).trim();
   rl.close();
   return answer || current || "";
 }
@@ -256,13 +341,74 @@ async function optionalValue(name, question, fallback) {
   return answer;
 }
 
+function defaultAuthMode() {
+  if (args["auth-mode"]) return args["auth-mode"];
+  const hasBasic = Boolean(
+    args["auth-user"] ||
+    args["auth-password"] ||
+    process.env.AUTH_USERNAME ||
+    process.env.AUTH_PASSWORD,
+  );
+  const hasGitHub = Boolean(
+    args["client-id"] ||
+    args["client-secret"] ||
+    args["github-userid"] ||
+    process.env.GITHUB_CLIENT_ID ||
+    process.env.GITHUB_CLIENT_SECRET,
+  );
+  if (hasBasic && hasGitHub) return "both";
+  if (hasBasic) return "basic";
+  if (hasGitHub) return "github";
+  return defaults["auth-mode"] || (input.isTTY ? "basic" : "none");
+}
+
+async function chooseAuthMode(fallback) {
+  const modes = new Set(["basic", "github", "both", "none"]);
+  if (args["auth-mode"]) {
+    if (!modes.has(args["auth-mode"]))
+      throw new Error("--auth-mode must be basic, github, both, or none");
+    return args["auth-mode"];
+  }
+  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`);
+
+  const rl = createInterface({ input, output });
+  const answer = (await rl.question(`Authentication [${fallback}]: `)).trim();
+  rl.close();
+
+  if (!answer) return modes.has(fallback) ? fallback : "basic";
+  if (modes.has(answer)) return answer;
+  if (answer === "1") return "basic";
+  if (answer === "2") return "github";
+  if (answer === "3") return "both";
+  if (answer === "4") return "none";
+  throw new Error("Authentication must be basic, github, both, or none");
+}
+
+function usesBasicAuth(mode) {
+  return mode === "basic" || mode === "both";
+}
+
+function usesGitHubAuth(mode) {
+  return mode === "github" || mode === "both";
+}
+
 async function chooseBase(fallback) {
   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]})`)}`));
+  names.forEach((name, index) =>
+    console.log(
+      `  ${color.cyan(String(index + 1))}. ${name} ${color.dim(`(${bases[name]})`)}`,
+    ),
+  );
   console.log(`  ${color.cyan("4")}. custom image`);
 
   const rl = createInterface({ input, output });
@@ -272,7 +418,8 @@ async function chooseBase(fallback) {
   if (!answer) return fallback;
   if (bases[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"]);
+  if (answer === "4")
+    return value("custom-base", "Custom base image", defaults["custom-base"]);
   return answer;
 }
 
@@ -285,7 +432,9 @@ async function readDefaults(file) {
 }
 
 async function writeDefaults(file, data) {
-  const clean = Object.fromEntries(Object.entries(data).filter(([, value]) => value));
+  const clean = Object.fromEntries(
+    Object.entries(data).filter(([, value]) => value),
+  );
   await mkdir(path.dirname(file), { recursive: true });
   await writeFile(file, `${JSON.stringify(clean, null, 2)}\n`);
 }
@@ -302,8 +451,10 @@ function parseArgs(argv) {
     if (!arg.startsWith("--")) continue;
 
     const [rawKey, rawValue] = arg.slice(2).split("=", 2);
-    out[rawKey] = rawValue ?? (argv[i + 1]?.startsWith("--") ? true : argv[i + 1]) ?? true;
-    if (rawValue === undefined && argv[i + 1] && !argv[i + 1].startsWith("--")) i += 1;
+    out[rawKey] =
+      rawValue ?? (argv[i + 1]?.startsWith("--") ? true : argv[i + 1]) ?? true;
+    if (rawValue === undefined && argv[i + 1] && !argv[i + 1].startsWith("--"))
+      i += 1;
   }
   return out;
 }
@@ -312,7 +463,10 @@ function parseCommand(argv) {
   const known = new Set(["create", "doctor", "help"]);
   const first = argv[0];
   if (first && !first.startsWith("--")) {
-    return { command: known.has(first) ? first : first, args: parseArgs(argv.slice(1)) };
+    return {
+      command: known.has(first) ? first : first,
+      args: parseArgs(argv.slice(1)),
+    };
   }
   return { command: "create", args: parseArgs(argv) };
 }
@@ -320,7 +474,9 @@ function parseCommand(argv) {
 function run(command, commandArgs) {
   return new Promise((resolve, reject) => {
     let seenUrl = "";
-    const child = spawn(command, commandArgs, { stdio: ["inherit", "pipe", "pipe"] });
+    const child = spawn(command, commandArgs, {
+      stdio: ["inherit", "pipe", "pipe"],
+    });
 
     child.stdout.on("data", (chunk) => {
       const text = chunk.toString();
@@ -337,7 +493,8 @@ function run(command, commandArgs) {
     child.on("error", reject);
     child.on("close", (code) => {
       if (code === 0 && seenUrl) resolve(seenUrl);
-      else if (code === 0) reject(new Error("vercel finished but no deployment url was found"));
+      else if (code === 0)
+        reject(new Error("vercel finished but no deployment url was found"));
       else reject(new Error(`vercel exited with code ${code}`));
     });
   });
@@ -346,7 +503,9 @@ function run(command, commandArgs) {
 function runCapture(command, commandArgs) {
   return new Promise((resolve, reject) => {
     let text = "";
-    const child = spawn(command, commandArgs, { stdio: ["ignore", "pipe", "pipe"] });
+    const child = spawn(command, commandArgs, {
+      stdio: ["ignore", "pipe", "pipe"],
+    });
     child.stdout.on("data", (chunk) => {
       text += chunk.toString();
     });
@@ -356,7 +515,8 @@ function runCapture(command, commandArgs) {
     child.on("error", reject);
     child.on("close", (code) => {
       if (code === 0) resolve(text.trim());
-      else reject(new Error(text.trim() || `${command} exited with code ${code}`));
+      else
+        reject(new Error(text.trim() || `${command} exited with code ${code}`));
     });
   });
 }
@@ -378,7 +538,9 @@ 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(
+    color.dim("Build a Container deployment from a tiny Dockerfile.vercel"),
+  );
   console.log("");
 }
 
@@ -392,10 +554,20 @@ function printSummary(items) {
 
 function printOAuthGuide(callbackUrl) {
   console.log(color.bold("GitHub OAuth"));
-  console.log(`${color.yellow("!")} Set this callback URL in your GitHub OAuth App before deploying:`);
+  console.log(
+    `${color.yellow("!")} Set this callback URL in your GitHub OAuth App before deploying:`,
+  );
   console.log(`  ${color.bold(callbackUrl)}`);
-  console.log(color.dim("  GitHub: Settings -> Developer settings -> OAuth Apps -> Authorization callback URL"));
-  console.log(color.dim("  User ID: open https://api.github.com/users/YOUR_LOGIN and copy the numeric id"));
+  console.log(
+    color.dim(
+      "  GitHub: Settings -> Developer settings -> OAuth Apps -> Authorization callback URL",
+    ),
+  );
+  console.log(
+    color.dim(
+      "  User ID: open https://api.github.com/users/YOUR_LOGIN and copy the numeric id",
+    ),
+  );
   console.log("");
 }
 
@@ -432,6 +604,7 @@ Options:
   --project NAME       Vercel project name
   --scope SLUG         Optional Vercel team/user scope slug
   --from IMAGE         Source image for /app/bin/wsterm
+  --auth-mode MODE     basic, github, both, or none
   --auth-user VALUE    Username/password auth user
   --auth-password VAL  Username/password auth password
   --client-id VALUE    GitHub OAuth client id

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vercel-vm-factory",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Create Vercel Container deployments for ws-shell from selectable base images.",
   "license": "MIT",
   "type": "module",