@localctl/cli 0.4.0 → 0.4.1

package/README.md

@@ -318,6 +318,7 @@ The full documentation lives at **[psilvmoreira.github.io/localctl](https://psil
 |---|---|
 | [Getting started](https://psilvmoreira.github.io/localctl/getting-started/) | Install and first deploy, step by step |
 | [Architecture](https://psilvmoreira.github.io/localctl/architecture/) | Every component, why it was chosen, multi-project support |
+| [CLI commands](https://psilvmoreira.github.io/localctl/cli-reference/) | Every command and option |
 | [Config schema](https://psilvmoreira.github.io/localctl/config-schema/) | Every `.local/config.json` field |
 | [Debugging](https://psilvmoreira.github.io/localctl/debugging/) | Attach a debugger in Node, Python, Go, Java and .NET |
 | [Adding tools](https://psilvmoreira.github.io/localctl/adding-tools/) | Write your own per-app or cluster-wide addon |
@@ -339,7 +340,8 @@ The full documentation lives at **[psilvmoreira.github.io/localctl](https://psil
 
 ## Contributing
 
-Issues and pull requests are welcome.
+Issues and pull requests are welcome. The full guide (constraints, dependency policy, working on
+the docs site) is in [**Contributing**](https://psilvmoreira.github.io/localctl/contributing/).
 
 1. Fork the repository and create a branch.
 2. Make your change and run the tests:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@localctl/cli",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "localctl - local Kubernetes dev platform CLI",
   "keywords": [
     "kubernetes",

package/src/commands/uninstall.js

@@ -91,7 +91,12 @@ async function uninstall(opts) {
   logger.success('Uninstall complete.');
   console.log('');
   console.log('Left in place (remove yourself if you want them gone too):');
-  console.log('  brew uninstall k3d kubectl tilt mkcert node   # only if nothing else needs them');
+  if (process.platform === 'win32') {
+    console.log('  winget uninstall k3d.k3d Kubernetes.kubectl FiloSottile.mkcert Helm.Helm   # only if nothing else needs them');
+    console.log('  Remove-Item -Recurse -Force ~\\.localctl\\tools   # tilt, if localctl installed it');
+  } else {
+    console.log('  brew uninstall k3d kubectl tilt mkcert helm   # only if nothing else needs them');
+  }
   console.log("  mkcert -uninstall   # removes the root CA from trust stores - affects EVERY");
   console.log('                      # mkcert-issued cert on this machine, not just *.local.test');
 }

package/src/index.js

@@ -2,6 +2,9 @@ const { Command } = require('commander');
 const { version } = require('../package.json');
 
 require('./lib/updateCheck').start(version);
+// Tools localctl downloaded itself (e.g. tilt on Windows) work even in a terminal opened before
+// they were added to the user's PATH.
+require('./lib/toolInstall').addToolsDirToPath();
 
 const program = new Command();
 program

package/src/lib/clusterProvision.js

@@ -4,7 +4,7 @@ const path = require('path');
 const yaml = require('js-yaml');
 const { run, capture, sleepSync, commandExists } = require('./exec');
 const { detectEngine, warnIfExperimental } = require('./engine');
-const { installIfMissing } = require('./toolInstall');
+const { installIfMissing, installTiltWindows } = require('./toolInstall');
 const { ensureInsecureRegistry } = require('./podman');
 const { DOMAIN } = require('./constants');
 const logger = require('./logger');
@@ -49,9 +49,9 @@ function provisionCluster({ clusterName, httpPort, httpsPort, registryPort }) {
     ensureInsecureRegistry(registryPort);
   }
 
-  installIfMissing('k3d', 'k3d', 'k3d-io.k3d');
+  installIfMissing('k3d', 'k3d', 'k3d.k3d');
   installIfMissing('kubectl', 'kubernetes-cli', 'Kubernetes.kubectl');
-  installIfMissing('tilt', 'tilt', 'Tilt.dev.tilt');
+  installIfMissing('tilt', 'tilt', installTiltWindows);
   installIfMissing('mkcert', 'mkcert', 'FiloSottile.mkcert');
   installIfMissing('helm', 'helm', 'Helm.Helm');
 

package/src/lib/toolInstall.js

@@ -1,7 +1,72 @@
+const fs = require('fs');
+const path = require('path');
 const { commandExists, run } = require('./exec');
 const logger = require('./logger');
+const { HOME_STATE_DIR } = require('./paths');
 
-// macId: Homebrew formula name. winId: winget package id.
+// Tools that have no package-manager package on a platform get downloaded here instead. The
+// directory is added to the user's PATH for new terminals, and to this process's PATH by
+// addToolsDirToPath() on every run, so the current terminal needs no restart.
+const TOOLS_DIR = path.join(HOME_STATE_DIR, 'tools');
+
+function prependToPath(dir) {
+  if (!fs.existsSync(dir)) return;
+  const entries = (process.env.PATH || '').split(path.delimiter);
+  if (!entries.includes(dir)) process.env.PATH = [dir, ...entries].join(path.delimiter);
+}
+
+function addToolsDirToPath() {
+  prependToPath(TOOLS_DIR);
+}
+
+// winget puts portable packages (k3d, kubectl, helm, mkcert) behind links in this directory and
+// adds it to PATH for new terminals only. Adding it here lets the rest of `localctl setup` use a
+// tool winget just installed.
+function addWingetLinksToPath() {
+  if (process.env.LOCALAPPDATA) prependToPath(path.join(process.env.LOCALAPPDATA, 'Microsoft', 'WinGet', 'Links'));
+}
+
+function powershell(script) {
+  run('powershell', ['-NoProfile', '-NonInteractive', '-ExecutionPolicy', 'Bypass', '-Command', script]);
+}
+
+// Tilt isn't published to winget. Same steps as Tilt's own install.ps1 (latest release zip from
+// GitHub), but into TOOLS_DIR and with the directory added to the user's PATH, which install.ps1
+// leaves to you.
+function installTiltWindows() {
+  logger.step('Installing tilt from its GitHub release (not available on winget)...');
+  powershell(`
+    $ErrorActionPreference = 'Stop'
+    $ProgressPreference = 'SilentlyContinue'
+    $dir = '${TOOLS_DIR.replace(/'/g, "''")}'
+    $version = (Invoke-RestMethod 'https://api.github.com/repos/tilt-dev/tilt/releases/latest').tag_name.TrimStart('v')
+    $url = "https://github.com/tilt-dev/tilt/releases/download/v$version/tilt.$version.windows.x86_64.zip"
+    $tmp = Join-Path $env:TEMP "localctl-tilt-$version"
+    if (Test-Path $tmp) { Remove-Item -Recurse -Force $tmp }
+    New-Item -ItemType Directory -Force -Path $tmp, $dir | Out-Null
+    Write-Host "Downloading $url"
+    Invoke-WebRequest $url -OutFile "$tmp\\tilt.zip"
+    Expand-Archive "$tmp\\tilt.zip" -DestinationPath $tmp
+    Move-Item -Force "$tmp\\tilt.exe" "$dir\\tilt.exe"
+    Remove-Item -Recurse -Force $tmp
+    # Raw registry value, so entries like %USERPROFILE%\\bin stay unexpanded (REG_EXPAND_SZ).
+    $key = [Microsoft.Win32.Registry]::CurrentUser.OpenSubKey('Environment', $true)
+    $userPath = [string]$key.GetValue('Path', '', 'DoNotExpandEnvironmentNames')
+    if ((($userPath -split ';') | Where-Object { $_ -eq $dir }).Count -eq 0) {
+      $key.SetValue('Path', (($userPath.TrimEnd(';'), $dir) -join ';').TrimStart(';'), 'ExpandString')
+      # Setting any user variable through .NET broadcasts WM_SETTINGCHANGE, so terminals opened
+      # from now on pick up the new PATH without signing out.
+      [Environment]::SetEnvironmentVariable('LOCALCTL_PATH_REFRESH', '1', 'User')
+      [Environment]::SetEnvironmentVariable('LOCALCTL_PATH_REFRESH', $null, 'User')
+    }
+    $key.Close()
+  `);
+  addToolsDirToPath();
+  logger.success(`tilt installed in ${TOOLS_DIR} (added to your PATH for new terminals)`);
+}
+
+// macId: Homebrew formula name. winId: winget package id, or a function that installs the tool
+// when winget doesn't have it.
 function installIfMissing(bin, macId, winId) {
   if (commandExists(bin)) {
     logger.success(`${bin} already installed`);
@@ -14,6 +79,10 @@ function installIfMissing(bin, macId, winId) {
     logger.step(`Installing ${macId} via brew...`);
     run('brew', ['install', macId]);
   } else if (process.platform === 'win32') {
+    if (typeof winId === 'function') {
+      winId();
+      return;
+    }
     if (!commandExists('winget')) {
       throw new Error('winget is required to install missing tools (ships with modern Windows / App Installer).');
     }
@@ -22,9 +91,10 @@ function installIfMissing(bin, macId, winId) {
       'install', '--id', winId, '-e', '--source', 'winget',
       '--accept-package-agreements', '--accept-source-agreements',
     ]);
+    addWingetLinksToPath();
   } else {
     throw new Error(`"${bin}" is missing and automatic install isn't supported on this platform. Install it manually.`);
   }
 }
 
-module.exports = { installIfMissing };
+module.exports = { installIfMissing, installTiltWindows, addToolsDirToPath, TOOLS_DIR };