@kvbox/cli 0.5.26 → 0.5.27

package/dist/kvbox.js

@@ -149,7 +149,7 @@ async function spin(message, work, opts = {}) {
 }
 
 // src/program.ts
-import { Command as Command61 } from "commander";
+import { Command as Command65 } from "commander";
 
 // ../shared/src/version.ts
 import { createRequire } from "module";
@@ -164,7 +164,7 @@ function versionOf(srcFileUrl, injected) {
 }
 
 // src/version.ts
-var VERSION = versionOf(import.meta.url, true ? "0.5.26" : void 0);
+var VERSION = versionOf(import.meta.url, true ? "0.5.27" : void 0);
 
 // src/commands/vm/index.ts
 import { Command as Command26 } from "commander";
@@ -442,6 +442,19 @@ var SubdomainSchema = z2.object({
   url: z2.string(),
   routes: z2.array(z2.object({ name: z2.string(), port: BoxPortSchema, url: z2.string() }))
 });
+var AddDomainRequest = z2.object({ domain: z2.string(), port: BoxPortSchema.optional() });
+var DomainSchema = z2.object({
+  owner: z2.string(),
+  box: z2.string(),
+  domain: z2.string(),
+  port: BoxPortSchema,
+  status: z2.enum(["pending", "live"]),
+  www: z2.boolean(),
+  url: z2.string(),
+  error: z2.string().nullable(),
+  records: z2.array(z2.object({ type: z2.enum(["A", "TXT", "CNAME"]), name: z2.string(), value: z2.string() })),
+  createdAt: z2.string()
+});
 var MachineSchema = z2.object({
   /** Host-unique short id (the tap is `kv-<id>`). Missing only on a box made before ids that has not restarted since. */
   id: z2.string(),
@@ -1145,6 +1158,17 @@ var ServerClient = class {
   listSubdomains() {
     return this.call("GET", "/subdomains", z3.array(SubdomainSchema));
   }
+  /** Custom domains (#89), the control plane's only: serve the box at the user's own name. */
+  addDomain(name, req) {
+    return this.call("POST", `/machines/${encodeURIComponent(name)}/domains`, DomainSchema, req);
+  }
+  removeDomain(name, domain) {
+    return this.call("DELETE", `/machines/${encodeURIComponent(name)}/domains/${encodeURIComponent(domain)}`, DomainSchema);
+  }
+  /** Every readable box's custom domains. */
+  listDomains() {
+    return this.call("GET", "/domains", z3.array(DomainSchema));
+  }
   /** A running box's own load, memory and disk, asked of its guest (#67). */
   machineStats(name) {
     return this.call("GET", `/machines/${encodeURIComponent(name)}/stats`, MachineStatsSchema);
@@ -1294,8 +1318,8 @@ var me = (client) => client.target.kind === "cloud" ? client.target.user : void
 async function clientFor(opts, client = {}) {
   return new ServerClient(await resolveTarget(opts), client);
 }
-function sshEndpoint(box, target) {
-  if (target.kind === "local") return { host: box.ip, port: 22, user: BOX_SSH_USER };
+function sshEndpoint(box, target, direct = false) {
+  if (target.kind === "local" || direct) return { host: box.ip, port: 22, user: BOX_SSH_USER };
   if (box.ssh === void 0) throw new KvboxError(`box ${box.name} has no public SSH port`);
   return { ...box.ssh, alias: `${box.id}.${box.ssh.host}` };
 }
@@ -1338,6 +1362,11 @@ async function waitForSsh(ep, timeoutMs = 3e4) {
   }
   throw new KvboxError(`box at ${ep.host}:${ep.port} did not answer within ${Math.round(timeoutMs / 1e3)}s`);
 }
+async function checkDirect(ep) {
+  await waitForSsh(ep, 2e3).catch(() => {
+    throw new KvboxError(`--direct: cannot reach ${ep.host}:${ep.port}; it works only on the box's host (leave it out to go through the public address)`);
+  });
+}
 var NOT_A_HOST_HINT = "kvbox-server is not installed, so this machine is not a kvbox host. Set it up with install-server.sh, or log in to the cloud with: kvbox login";
 async function lastErrorLine(logPath, from = 0) {
   const { readFile: readFile8 } = await import("fs/promises");
@@ -1646,8 +1675,12 @@ function parseIdleTimeout(text2) {
 
 // src/commands/vm/connect.ts
 var SSH_FAILED = 255;
-var connectCommand = new Command2("connect").alias("cn").description("open a shell in a box over SSH (or run a command: kvbox connect <name> -- <cmd>)").argument("[name]", "box name (picked from a list when left out)").argument("[cmd...]", "command to run instead of a shell").passThroughOptions().action(async (nameArg, cmdArgs, _opts, cmd) => {
+var connectCommand = new Command2("connect").alias("cn").description("open a shell in a box over SSH (or run a command: kvbox connect <name> -- <cmd>)").argument("[name]", "box name (picked from a list when left out)").argument("[cmd...]", "command to run instead of a shell").option("--direct", "on the box's host: ssh to the box's private ip, not through the public address or relay").passThroughOptions().action(async (nameArg, cmdArgs, opts, cmd) => {
   if (nameArg === void 0) askOrUsage("give the box: kvbox connect <name>");
+  if (cmdArgs[0] === "--direct") {
+    opts.direct = true;
+    cmdArgs = cmdArgs.slice(cmdArgs[1] === "--" ? 2 : 1);
+  }
   const client = await clientFor(cmd.optsWithGlobals());
   let ep;
   let cert;
@@ -1660,8 +1693,9 @@ var connectCommand = new Command2("connect").alias("cn").description("open a she
     owner = box.owner;
     const wasRunning = box.status === "running";
     if (!wasRunning) box = await wakeUp(client, box, displayName(box, me(client)));
-    ep = sshEndpoint(box, client.target);
+    ep = sshEndpoint(box, client.target, opts.direct);
     if (!wasRunning) await spin(`waiting for ${name} to accept SSH\u2026`, waitForSsh(ep));
+    else if (opts.direct) await checkDirect(ep);
   } finally {
     await client.close();
   }
@@ -1726,7 +1760,7 @@ async function runSsh(ssh, opts) {
   }).finally(() => clearTimeout(timer));
   return { status: status2, chunks, timedOut };
 }
-var execCommand = new Command3("exec").description("run a command in a box and exit with its status (kvbox exec <name> -- <cmd>)").argument("<name>", "box name").argument("<cmd...>", "command, passed to the box's shell as one string (pipes, &&, cd work)").option("-e, --env <KEY=VALUE>", "set an environment variable for the command (repeatable)", collect).option("--timeout <seconds>", "kill the command after N seconds and exit 124", positiveSeconds).option("--tty", "allocate a pseudo-terminal (for interactive tools like htop)").option("--json", 'capture output and print {"output": "...", "exit_code": N}').action(async (name, cmdArgs, opts, cmd) => {
+var execCommand = new Command3("exec").description("run a command in a box and exit with its status (kvbox exec <name> -- <cmd>)").argument("<name>", "box name").argument("<cmd...>", "command, passed to the box's shell as one string (pipes, &&, cd work)").option("-e, --env <KEY=VALUE>", "set an environment variable for the command (repeatable)", collect).option("--timeout <seconds>", "kill the command after N seconds and exit 124", positiveSeconds).option("--tty", "allocate a pseudo-terminal (for interactive tools like htop)").option("--json", 'capture output and print {"output": "...", "exit_code": N}').option("--direct", "on the box's host: ssh to the box's private ip, not through the public address or relay").action(async (name, cmdArgs, opts, cmd) => {
   const client = await clientFor(cmd.optsWithGlobals());
   let ep;
   let cert;
@@ -1739,8 +1773,9 @@ var execCommand = new Command3("exec").description("run a command in a box and e
     owner = box.owner;
     const wasRunning = box.status === "running";
     if (!wasRunning) box = await wakeUp(client, box, displayName(box, me(client)));
-    ep = sshEndpoint(box, client.target);
+    ep = sshEndpoint(box, client.target, opts.direct);
     if (!wasRunning) await spin(`waiting for ${name} to accept SSH\u2026`, waitForSsh(ep));
+    else if (opts.direct) await checkDirect(ep);
   } finally {
     await client.close();
   }
@@ -1958,6 +1993,7 @@ import { Command as Command9 } from "commander";
 
 // ../shared/src/names.ts
 import { createHmac } from "crypto";
+var DEFAULT_PROXY_DOMAIN = "kvbox.app";
 var LABEL_RE = /^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/;
 var RESERVED_SUBDOMAINS = /* @__PURE__ */ new Set([
   "admin",
@@ -2006,6 +2042,21 @@ function assertRouteName(text2) {
   if (problem) throw new KvboxError(`name ${problem}`);
   return text2;
 }
+var PLATFORM_DOMAINS = ["kvbox.sh", DEFAULT_PROXY_DOMAIN];
+function domainProblem(text2, proxyDomain) {
+  if (text2.length > 253) return `"${text2}" is longer than a domain may be`;
+  const labels = text2.split(".");
+  if (labels.length < 2 || labels.some((l) => l.length > 63 || !LABEL_RE.test(l))) return `"${text2}" is not a domain like example.com or www.example.com (lowercase, no "*", no "https://")`;
+  if (!/^[a-z]{2,}$/.test(labels.at(-1)) && !labels.at(-1).startsWith("xn--")) return `"${text2}" does not end in a top-level domain`;
+  const ours = [...PLATFORM_DOMAINS, ...proxyDomain ? [proxyDomain] : []];
+  if (ours.some((d) => text2 === d || text2.endsWith(`.${d}`))) return `"${text2}" belongs to kvbox; bring a domain of your own`;
+  return null;
+}
+function assertDomain(text2, proxyDomain) {
+  const problem = domainProblem(text2, proxyDomain);
+  if (problem) throw new KvboxError(`domain ${problem}`);
+  return text2;
+}
 
 // src/commands/vm/proxy/claim.ts
 var claimCommand = new Command9("claim").description("give a box its HTTPS address, https://<subdomain>.kvbox.app, serving one of its ports").argument("[box]", "box name (picked from a list when left out)").argument("[subdomain]", "3-63 lowercase letters, digits and '-'; must be free (asked for when left out)").option("--port <port>", "the box port the address serves (asked for when left out)").option("--json", "print the subdomain as JSON").action(async (nameArg, subArg, opts, cmd) => {
@@ -3955,13 +4006,120 @@ var setCommand2 = new Command59("set").description("add or change a variable; bo
 var envCommand = new Command60("env").description("environment variables every box of yours gets when it starts (secrets too)").addCommand(lsCommand7, { isDefault: true }).addCommand(setCommand2).addCommand(rmCommand7);
 for (const cmd of envCommand.commands) cmd.option("--org <slug>", "the org's variables instead of yours");
 
+// src/commands/domain/index.ts
+import { Command as Command64 } from "commander";
+
+// src/commands/domain/add.ts
+import { Command as Command61 } from "commander";
+
+// src/commands/domain/shared.ts
+function requireCloud3(client) {
+  if (client.target.kind !== "cloud") throw new KvboxError("custom domains need the kvbox cloud: kvbox login (this host's own socket has none)");
+}
+var boxOf2 = (d, user) => user !== void 0 && d.owner !== user ? `${d.owner}/${d.box}` : d.box;
+function domainJson(d, user) {
+  return { domain: d.domain, box: boxOf2(d, user), port: d.port, status: d.status, www: d.www, url: d.url, error: d.error, records: d.records, createdAt: d.createdAt };
+}
+
+// src/commands/domain/add.ts
+var addCommand3 = new Command61("add").description("serve a box at a domain of your own, https://<domain>, with its certificate made for you").argument("<domain>", "a domain you control, like example.com or app.example.com").argument("<box>", "box name").option("--port <port>", "the box port the domain serves (default: the port of its kvbox.app address)").option("--json", "print the domain as JSON").action(async (domainArg, name, opts, cmd) => {
+  const domain = assertDomain(domainArg.trim().toLowerCase());
+  const port = opts.port === void 0 ? void 0 : parsePorts([opts.port])[0];
+  const client = await clientFor(cmd.optsWithGlobals());
+  try {
+    requireCloud3(client);
+    const user = me(client);
+    const box = displayName(await findBox(client, name), user);
+    const d = await spin(`adding ${domain}\u2026`, client.addDomain(box, { domain, ...port !== void 0 ? { port } : {} }));
+    if (opts.json) {
+      json(domainJson(d, user));
+      return;
+    }
+    if (d.status === "live") {
+      info(`${color.green("\u2713")} ${color.bold(d.url)} \u2192 box ${color.bold(box)} port ${d.port}`);
+      info("  the certificate is made on the first visit, which can take a few seconds");
+      return;
+    }
+    info(`${color.green("\u2713")} ${domain} added for box ${color.bold(box)} port ${d.port}, waiting for its DNS`);
+    info(`
+At the company that runs the DNS of ${domain}, add:
+`);
+    table(d.records.map((r) => ({ type: r.type, name: r.name, value: r.value })));
+    info(`
+  (the TXT record shows ${domain} is yours; keep it, it is checked again if the domain ever goes back to pending)`);
+    if (d.records.some((r) => r.type === "CNAME")) info(`  (the www record is optional: with it, www.${domain} serves the same site)`);
+    info(`
+kvbox checks every minute; ${domain} is served at ${d.url} once its records are set (kvbox domain ls).`);
+    if (d.error) info(color.dim(`  now: ${d.error}`));
+  } finally {
+    await client.close();
+  }
+});
+
+// src/commands/domain/ls.ts
+import { Command as Command62 } from "commander";
+var lsCommand8 = new Command62("ls").alias("list").description("list your custom domains and whether they are live").option("--json", "print as JSON").action(async (opts, cmd) => {
+  const client = await clientFor(cmd.optsWithGlobals());
+  try {
+    requireCloud3(client);
+    const user = me(client);
+    const domains = await client.listDomains();
+    if (opts.json) {
+      json(domains.map((d) => domainJson(d, user)));
+      return;
+    }
+    if (domains.length === 0) {
+      info("no custom domains (kvbox domain add <domain> <box>)");
+      return;
+    }
+    table(
+      domains.map((d) => ({
+        domain: d.www ? `${d.domain} (+www)` : d.domain,
+        box: boxOf2(d, user),
+        port: d.port,
+        status: d.status === "live" ? "live" : "pending dns",
+        note: d.status === "live" ? d.url : d.error ?? ""
+      }))
+    );
+  } finally {
+    await client.close();
+  }
+});
+
+// src/commands/domain/rm.ts
+import { Command as Command63 } from "commander";
+var rmCommand8 = new Command63("rm").alias("remove").description("stop serving a box at a custom domain").argument("<domain>", "the domain").option("-y, --yes", "do not ask for confirmation").action(async (domainArg, opts, cmd) => {
+  const domain = domainArg.trim().toLowerCase();
+  const client = await clientFor(cmd.optsWithGlobals());
+  try {
+    requireCloud3(client);
+    const found = (await client.listDomains()).find((d) => d.domain === domain);
+    if (!found) throw new KvboxError(`domain ${domain}: not found (kvbox domain ls)`);
+    const box = boxOf2(found, me(client));
+    if (!await confirm(`Stop serving box ${box} at ${domain}?`, opts.yes ?? false)) {
+      info("cancelled");
+      process.exitCode = 1;
+      return;
+    }
+    await spin(`removing ${domain}\u2026`, client.removeDomain(`${found.owner}/${found.box}`, domain));
+    info(`${color.green("\u2713")} ${domain} no longer serves box ${box} (you can remove its DNS record)`);
+  } finally {
+    await client.close();
+  }
+});
+
+// src/commands/domain/index.ts
+var domainCommand = new Command64("domain").alias("domains").description("serve a box at a domain of your own").addCommand(addCommand3).addCommand(lsCommand8).addCommand(rmCommand8);
+for (const cmd of domainCommand.commands) cmd.option("--org <slug>", "act in this org (- for your personal boxes)");
+
 // src/program.ts
 function buildProgram() {
-  const program = new Command61("kvbox").description("self-hosted Firecracker microVMs with Docker-like ergonomics").version(VERSION, "-v, --version").option("--local", "use this machine's kvbox-server over its socket, ignoring kvbox login").option("--org <slug>", "the org: where kvbox new creates, and which box a name means when it is not one of yours; before the command here, or after it").showHelpAfterError().enablePositionalOptions();
+  const program = new Command65("kvbox").description("self-hosted Firecracker microVMs with Docker-like ergonomics").version(VERSION, "-v, --version").option("--local", "use this machine's kvbox-server over its socket, ignoring kvbox login").option("--org <slug>", "the org: where kvbox new creates, and which box a name means when it is not one of yours; before the command here, or after it").showHelpAfterError().enablePositionalOptions();
   program.addCommand(vmCommand);
   program.addCommand(snapshotsCommand);
   program.addCommand(volumeCommand);
   program.addCommand(envCommand);
+  program.addCommand(domainCommand);
   program.addCommand(serverCommand);
   program.addCommand(loginCommand);
   program.addCommand(logoutCommand);