@localctl/cli 0.2.0 → 0.4.0

package/src/commands/up.js

@@ -1,123 +1,123 @@
-const fs = require('fs');
-const { loadConfig } = require('../lib/loadConfig');
-const { syncHosts, registerApp } = require('../lib/hostsFile');
-const { run, capture, sleepSync, spawnDetached, getFreePort, isRunning } = require('../lib/exec');
-const { detectEngine } = require('../lib/engine');
-const { ensureClusterUp } = require('../lib/clusterProvision');
-const { portsFor } = require('../lib/profileStore');
-const { listKeys } = require('../lib/appSecrets');
-const { runFiles } = require('../lib/paths');
-const { DOMAIN, DEFAULT_HTTPS_PORT } = require('../lib/constants');
-const ui = require('../lib/ui');
-const logger = require('../lib/logger');
-
-function podmanBuildEnv() {
-  const env = { ...process.env };
-  const detected = detectEngine();
-  if (detected && detected.engine === 'podman') {
-    // Podman's Docker-API-compat socket doesn't implement BuildKit's gRPC build protocol
-    // (Tilt's docker_build fails with "unable to upgrade to h2c" otherwise).
-    env.DOCKER_BUILDKIT = '0';
-    logger.info('Podman detected: disabling BuildKit for this build.');
-  }
-  return env;
-}
-
-function printEndpoints(cfg) {
-  const { httpsPort } = portsFor(cfg.profile);
-  const suffix = httpsPort === DEFAULT_HTTPS_PORT ? '' : `:${httpsPort}`;
-  const url = `https://${cfg.subdomain}.${DOMAIN}${suffix}`;
-  console.log('');
-  console.log(`${ui.check} ${ui.bold(cfg.name)} -> ${ui.url(url)}`);
-  if (cfg.debug.enabled && cfg.debug.port) {
-    console.log(`  debug:  localhost:${cfg.debug.port}`);
-  }
-  console.log(`  logs:   localctl app logs ${cfg.name} -f`);
-  console.log(`  status: localctl app status`);
-  console.log(`  stop:   localctl app down`);
-  console.log('');
-}
-
-function tailLog(logFile, lines) {
-  if (!fs.existsSync(logFile)) return null;
-  return fs.readFileSync(logFile, 'utf8').trim().split('\n').slice(-lines).join('\n');
-}
-
-module.exports = (program) => {
-  program
-    .command('up')
-    .option('-f, --foreground', 'run in the foreground with the interactive Tilt UI (default: detached, survives closing this terminal)')
-    .description('Deploy/dev-loop the app in the current directory')
-    .action(async (opts) => {
-      const cfg = loadConfig();
-      ensureClusterUp(cfg.clusterName, cfg.profile);
-
-      if (cfg.secrets.length > 0) {
-        const set = new Set(listKeys(cfg));
-        const missing = cfg.secrets.filter((key) => !set.has(key));
-        if (missing.length > 0) {
-          throw new Error(
-            `Missing secret value${missing.length > 1 ? 's' : ''} for: ${missing.join(', ')}. Set ` +
-            `${missing.length > 1 ? 'them' : 'it'} first:\n` +
-            missing.map((key) => `  localctl app secrets set ${key}`).join('\n'),
-          );
-        }
-      }
-
-      registerApp(cfg.subdomain);
-      syncHosts();
-      const env = podmanBuildEnv();
-
-      // Each app gets its own Tilt web UI port. Tilt's default (10350) is shared/fixed, so two
-      // apps running `localctl up` at once - the whole point of detached mode - would otherwise
-      // collide outright, and Tilt's resulting error doesn't explain why to someone who never
-      // asked to think about Tilt's own dashboard port in the first place.
-      const tiltPort = await getFreePort();
-
-      if (opts.foreground) {
-        logger.step(`Starting Tilt for "${cfg.name}" -> https://${cfg.subdomain}.${DOMAIN}`);
-        run('tilt', ['up', '--port', String(tiltPort)], { env });
-        return;
-      }
-
-      const { pidFile, portFile, logFile } = runFiles(cfg.name);
-      const pid = spawnDetached('tilt', ['up', '--port', String(tiltPort)], { cwd: process.cwd(), env, logFile });
-      fs.writeFileSync(pidFile, String(pid));
-      fs.writeFileSync(portFile, String(tiltPort));
-      logger.step(`Starting Tilt for "${cfg.name}" in the background (pid ${pid})...`);
-      logger.info(`Full Tilt output: tail -f ${logFile}`);
-
-      logger.step('Waiting for the deployment to become ready...');
-      // Tilt needs a moment to apply the generated manifests - "rollout status" errors outright
-      // on a Deployment that doesn't exist yet, it doesn't wait for one to appear.
-      let exists = false;
-      for (let i = 0; i < 30; i += 1) {
-        if (capture('kubectl', ['get', 'deployment', cfg.name, '-n', cfg.namespace]).status === 0) {
-          exists = true;
-          break;
-        }
-        if (!isRunning(pid)) break; // Tilt already died - no point waiting out the rest of the poll
-        sleepSync(1000);
-      }
-
-      const rollout = exists
-        ? run(
-            'kubectl',
-            ['rollout', 'status', `deployment/${cfg.name}`, '-n', cfg.namespace, '--timeout=180s'],
-            { allowFail: true },
-          )
-        : { status: 1 };
-
-      if (rollout.status === 0) {
-        printEndpoints(cfg);
-        return;
-      }
-
-      if (!isRunning(pid)) {
-        logger.warn(`Tilt exited before the deployment came up. Last lines of ${logFile}:`);
-        console.log(ui.dim(tailLog(logFile, 15) || '(log file is empty)'));
-      } else {
-        logger.warn(`Still starting (or something's wrong) - check "localctl app logs ${cfg.name} -f" or "localctl app status".`);
-      }
-    });
-};
+const fs = require('fs');
+const { loadConfig } = require('../lib/loadConfig');
+const { syncHosts, registerApp } = require('../lib/hostsFile');
+const { run, capture, sleepSync, spawnDetached, getFreePort, isRunning } = require('../lib/exec');
+const { detectEngine } = require('../lib/engine');
+const { ensureClusterUp } = require('../lib/clusterProvision');
+const { portsFor } = require('../lib/profileStore');
+const { listKeys } = require('../lib/appSecrets');
+const { runFiles } = require('../lib/paths');
+const { DOMAIN, DEFAULT_HTTPS_PORT } = require('../lib/constants');
+const ui = require('../lib/ui');
+const logger = require('../lib/logger');
+
+function podmanBuildEnv() {
+  const env = { ...process.env };
+  const detected = detectEngine();
+  if (detected && detected.engine === 'podman') {
+    // Podman's Docker-API-compat socket doesn't implement BuildKit's gRPC build protocol
+    // (Tilt's docker_build fails with "unable to upgrade to h2c" otherwise).
+    env.DOCKER_BUILDKIT = '0';
+    logger.info('Podman detected: disabling BuildKit for this build.');
+  }
+  return env;
+}
+
+function printEndpoints(cfg) {
+  const { httpsPort } = portsFor(cfg.profile);
+  const suffix = httpsPort === DEFAULT_HTTPS_PORT ? '' : `:${httpsPort}`;
+  const url = `https://${cfg.subdomain}.${DOMAIN}${suffix}`;
+  console.log('');
+  console.log(`${ui.check} ${ui.bold(cfg.name)} -> ${ui.url(url)}`);
+  if (cfg.debug.enabled && cfg.debug.port) {
+    console.log(`  debug:  localhost:${cfg.debug.port}`);
+  }
+  console.log(`  logs:   localctl app logs ${cfg.name} -f`);
+  console.log(`  status: localctl app status`);
+  console.log(`  stop:   localctl app down`);
+  console.log('');
+}
+
+function tailLog(logFile, lines) {
+  if (!fs.existsSync(logFile)) return null;
+  return fs.readFileSync(logFile, 'utf8').trim().split('\n').slice(-lines).join('\n');
+}
+
+module.exports = (program) => {
+  program
+    .command('up')
+    .option('-f, --foreground', 'run in the foreground with the interactive Tilt UI (default: detached, survives closing this terminal)')
+    .description('Deploy/dev-loop the app in the current directory')
+    .action(async (opts) => {
+      const cfg = loadConfig();
+      ensureClusterUp(cfg.clusterName, cfg.profile);
+
+      if (cfg.secrets.length > 0) {
+        const set = new Set(listKeys(cfg));
+        const missing = cfg.secrets.filter((key) => !set.has(key));
+        if (missing.length > 0) {
+          throw new Error(
+            `Missing secret value${missing.length > 1 ? 's' : ''} for: ${missing.join(', ')}. Set ` +
+            `${missing.length > 1 ? 'them' : 'it'} first:\n` +
+            missing.map((key) => `  localctl app secrets set ${key}`).join('\n'),
+          );
+        }
+      }
+
+      registerApp(cfg.subdomain);
+      syncHosts();
+      const env = podmanBuildEnv();
+
+      // Each app gets its own Tilt web UI port. Tilt's default (10350) is shared/fixed, so two
+      // apps running `localctl up` at once - the whole point of detached mode - would otherwise
+      // collide outright, and Tilt's resulting error doesn't explain why to someone who never
+      // asked to think about Tilt's own dashboard port in the first place.
+      const tiltPort = await getFreePort();
+
+      if (opts.foreground) {
+        logger.step(`Starting Tilt for "${cfg.name}" -> https://${cfg.subdomain}.${DOMAIN}`);
+        run('tilt', ['up', '--port', String(tiltPort)], { env });
+        return;
+      }
+
+      const { pidFile, portFile, logFile } = runFiles(cfg.name);
+      const pid = spawnDetached('tilt', ['up', '--port', String(tiltPort)], { cwd: process.cwd(), env, logFile });
+      fs.writeFileSync(pidFile, String(pid));
+      fs.writeFileSync(portFile, String(tiltPort));
+      logger.step(`Starting Tilt for "${cfg.name}" in the background (pid ${pid})...`);
+      logger.info(`Full Tilt output: tail -f ${logFile}`);
+
+      logger.step('Waiting for the deployment to become ready...');
+      // Tilt needs a moment to apply the generated manifests - "rollout status" errors outright
+      // on a Deployment that doesn't exist yet, it doesn't wait for one to appear.
+      let exists = false;
+      for (let i = 0; i < 30; i += 1) {
+        if (capture('kubectl', ['get', 'deployment', cfg.name, '-n', cfg.namespace]).status === 0) {
+          exists = true;
+          break;
+        }
+        if (!isRunning(pid)) break; // Tilt already died - no point waiting out the rest of the poll
+        sleepSync(1000);
+      }
+
+      const rollout = exists
+        ? run(
+            'kubectl',
+            ['rollout', 'status', `deployment/${cfg.name}`, '-n', cfg.namespace, '--timeout=180s'],
+            { allowFail: true },
+          )
+        : { status: 1 };
+
+      if (rollout.status === 0) {
+        printEndpoints(cfg);
+        return;
+      }
+
+      if (!isRunning(pid)) {
+        logger.warn(`Tilt exited before the deployment came up. Last lines of ${logFile}:`);
+        console.log(ui.dim(tailLog(logFile, 15) || '(log file is empty)'));
+      } else {
+        logger.warn(`Still starting (or something's wrong) - check "localctl app logs ${cfg.name} -f" or "localctl app status".`);
+      }
+    });
+};

package/src/index.js

@@ -1,36 +1,38 @@
-const { Command } = require('commander');
-const { version } = require('../package.json');
-
-const program = new Command();
-program
-  .name('localctl')
-  .description('Local Kubernetes dev platform CLI')
-  .version(version);
-
-// Global/machine-level - not tied to any one app or addon.
-require('./commands/setup')(program);
-require('./commands/uninstall')(program);
-require('./commands/doctor')(program);
-require('./commands/hosts')(program);
-
-// Feature-level command groups.
-const app = program.command('app').description('Manage a single app: scaffold, deploy, monitor');
-require('./commands/new')(app);
-require('./commands/up')(app);
-require('./commands/down')(app);
-require('./commands/status')(app);
-require('./commands/logs')(app);
-require('./commands/reload')(app);
-require('./commands/generateManifests')(app);
-require('./commands/registryInfo')(app);
-require('./commands/exec')(app);
-require('./commands/prune')(app);
-require('./commands/secrets')(app); // its own subgroup: set/unset/list/show
-
-require('./commands/addons')(program); // already its own group: list/enable/disable/status
-require('./commands/profiles')(program); // already its own group: new/list/switch/status
-
-program.parseAsync(process.argv).catch((err) => {
-  console.error(err && err.message ? err.message : err);
-  process.exit(1);
-});
+const { Command } = require('commander');
+const { version } = require('../package.json');
+
+require('./lib/updateCheck').start(version);
+
+const program = new Command();
+program
+  .name('localctl')
+  .description('Local Kubernetes dev platform CLI')
+  .version(version);
+
+// Global/machine-level - not tied to any one app or addon.
+require('./commands/setup')(program);
+require('./commands/uninstall')(program);
+require('./commands/doctor')(program);
+require('./commands/hosts')(program);
+
+// Feature-level command groups.
+const app = program.command('app').description('Manage a single app: scaffold, deploy, monitor');
+require('./commands/new')(app);
+require('./commands/up')(app);
+require('./commands/down')(app);
+require('./commands/status')(app);
+require('./commands/logs')(app);
+require('./commands/reload')(app);
+require('./commands/generateManifests')(app);
+require('./commands/registryInfo')(app);
+require('./commands/exec')(app);
+require('./commands/prune')(app);
+require('./commands/secrets')(app); // its own subgroup: set/unset/list/show
+
+require('./commands/addons')(program); // already its own group: list/enable/disable/status
+require('./commands/profiles')(program); // already its own group: new/list/switch/status
+
+program.parseAsync(process.argv).catch((err) => {
+  console.error(err && err.message ? err.message : err);
+  process.exit(1);
+});

package/src/lib/addonDirs.js

@@ -1,43 +1,43 @@
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
-
-// Addons are searched in two places, in precedence order:
-//   1. USER_DIR   - yours, never touched by a `localctl` update/reinstall. Defaults to
-//                   ~/.localctl/addons, overridable via LOCALCTL_ADDONS_DIR (e.g. to point at a
-//                   folder checked into your own infra repo instead).
-//   2. BUILTIN_DIR - the addons shipped with this CLI (postgres/redis/mongo/cluster/logging).
-// A user-dir addon of the same name replaces the built-in one; a new name just adds to the list.
-// This is what lets someone install this tool without inheriting its author's addon set, and
-// without forking the tool to add their own - see docs/adding-tools.md.
-const BUILTIN_DIR = path.join(__dirname, 'addons');
-const USER_DIR = process.env.LOCALCTL_ADDONS_DIR || path.join(os.homedir(), '.localctl', 'addons');
-
-function roots(...segments) {
-  return [path.join(USER_DIR, ...segments), path.join(BUILTIN_DIR, ...segments)];
-}
-
-// First matching addon.yaml wins - user dir searched before built-in.
-function findAddonDir(name, ...segments) {
-  for (const root of roots(...segments)) {
-    const dir = path.join(root, name);
-    if (fs.existsSync(path.join(dir, 'addon.yaml'))) return dir;
-  }
-  return null;
-}
-
-// Every addon name available across both locations, user-dir entries deduplicated against
-// built-ins of the same name (a listing, not a "which one wins" answer - see findAddonDir for that).
-function listAddonNames(...segments) {
-  const names = new Set();
-  for (const root of roots(...segments)) {
-    if (!fs.existsSync(root)) continue;
-    fs.readdirSync(root, { withFileTypes: true })
-      .filter((e) => e.isDirectory())
-      .filter((e) => fs.existsSync(path.join(root, e.name, 'addon.yaml')))
-      .forEach((e) => names.add(e.name));
-  }
-  return [...names];
-}
-
-module.exports = { BUILTIN_DIR, USER_DIR, findAddonDir, listAddonNames };
+const fs = require('fs');
+const os = require('os');
+const path = require('path');
+
+// Addons are searched in two places, in precedence order:
+//   1. USER_DIR   - yours, never touched by a `localctl` update/reinstall. Defaults to
+//                   ~/.localctl/addons, overridable via LOCALCTL_ADDONS_DIR (e.g. to point at a
+//                   folder checked into your own infra repo instead).
+//   2. BUILTIN_DIR - the addons shipped with this CLI (postgres/redis/mongo/cluster/logging).
+// A user-dir addon of the same name replaces the built-in one; a new name just adds to the list.
+// This is what lets someone install this tool without inheriting its author's addon set, and
+// without forking the tool to add their own - see docs/adding-tools.md.
+const BUILTIN_DIR = path.join(__dirname, 'addons');
+const USER_DIR = process.env.LOCALCTL_ADDONS_DIR || path.join(os.homedir(), '.localctl', 'addons');
+
+function roots(...segments) {
+  return [path.join(USER_DIR, ...segments), path.join(BUILTIN_DIR, ...segments)];
+}
+
+// First matching addon.yaml wins - user dir searched before built-in.
+function findAddonDir(name, ...segments) {
+  for (const root of roots(...segments)) {
+    const dir = path.join(root, name);
+    if (fs.existsSync(path.join(dir, 'addon.yaml'))) return dir;
+  }
+  return null;
+}
+
+// Every addon name available across both locations, user-dir entries deduplicated against
+// built-ins of the same name (a listing, not a "which one wins" answer - see findAddonDir for that).
+function listAddonNames(...segments) {
+  const names = new Set();
+  for (const root of roots(...segments)) {
+    if (!fs.existsSync(root)) continue;
+    fs.readdirSync(root, { withFileTypes: true })
+      .filter((e) => e.isDirectory())
+      .filter((e) => fs.existsSync(path.join(root, e.name, 'addon.yaml')))
+      .forEach((e) => names.add(e.name));
+  }
+  return [...names];
+}
+
+module.exports = { BUILTIN_DIR, USER_DIR, findAddonDir, listAddonNames };