keyman-cli 0.1.0 → 0.2.0

package/README.md

@@ -6,7 +6,16 @@ Install the Rust-based Keyman CLI with npm:
 npm install -g keyman-cli
 ```
 
-Create a private `.yml` file with one mapping per project:
+Get started:
+
+```sh
+keyman init          # create ~/.keyman.yml with an example project and load it
+keyman edit          # add your projects and secrets
+cd ~/code/my-app
+keyman inject        # write .env for the project named after this folder
+```
+
+The master file maps project names to quoted string values:
 
 ```yaml
 my-app:
@@ -14,13 +23,19 @@ my-app:
   DEBUG: "true"
 ```
 
-Then run:
+More commands (leave out the project to use the current folder name):
 
 ```sh
-keyman load /path/to/master.yml
-keyman inject my-app /path/to/existing/project
+keyman load /path/to/master.yml   # use an existing master file
+keyman status                     # check every project
+keyman show my-app [--reveal]     # variable names, values masked by default
+keyman diff [--reveal]            # git-style diff of .env against the master file
+keyman save [--dry-run]           # save this folder's .env back to the master file
+eval "$(keyman export my-app)"    # load variables into a POSIX shell
+keyman run my-app -- npm start    # run a command with the variables, no .env file
+keyman completions bash           # also zsh, fish, powershell
 ```
 
-`load` remembers the master file path. `inject` replaces the project's `.env` file. Keep the master file private and ignore `.env` in Git.
+Run `keyman help <command>` for details. Keep the master file private and ignore `.env` in Git.
 
-Prebuilt binaries are included for Windows x64, macOS Intel and Apple Silicon, and Linux x64 and ARM64. No Rust installation is needed. [Source and full documentation](https://github.com/moonmangit/keyman-cli).
+Prebuilt binaries are included for Windows x64, macOS Intel and Apple Silicon, and Linux x64 and ARM64. No Rust installation is needed. On Windows systems that block the native executable, the command can use WSL if it is installed. The executable is available as both `keyman` and `keyman-cli`. [Source and full documentation](https://github.com/moonmangit/keyman-cli).

package/bin/keyman.cjs

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 
 const fs = require('node:fs');
+const os = require('node:os');
 const path = require('node:path');
 const { spawnSync } = require('node:child_process');
 
@@ -25,7 +26,16 @@ if (!fs.existsSync(binary)) {
   process.exit(1);
 }
 
-const result = spawnSync(binary, process.argv.slice(2), { stdio: 'inherit' });
+const args = process.argv.slice(2);
+let result = spawnSync(binary, args, { stdio: 'inherit' });
+if (process.platform === 'win32' && result.error && ['UNKNOWN', 'EPERM', 'EACCES'].includes(result.error.code)) {
+  try {
+    result = runWithWsl(args);
+  } catch (error) {
+    console.error(`keyman: Windows blocked the native executable and WSL fallback failed: ${error.message}`);
+    process.exit(1);
+  }
+}
 if (result.error) {
   console.error(`keyman: ${result.error.message}`);
   process.exit(1);
@@ -35,3 +45,36 @@ if (result.signal) {
 } else {
   process.exitCode = result.status ?? 1;
 }
+
+function runWithWsl(args) {
+  const linuxBinary = path.join(__dirname, 'native', 'x86_64-unknown-linux-gnu', 'keyman');
+  if (!fs.existsSync(linuxBinary)) {
+    throw new Error('the Linux x64 binary is missing from this package');
+  }
+
+  const linuxArgs = [...args];
+  if (['load', 'init'].includes(linuxArgs[0]) && linuxArgs.length === 2 && !linuxArgs[1].startsWith('-')) {
+    linuxArgs[1] = toWslPath(linuxArgs[1]);
+  } else if (['inject', 'save', 'diff'].includes(linuxArgs[0]) && linuxArgs.length === 3 && !linuxArgs[2].startsWith('-')) {
+    linuxArgs[2] = toWslPath(linuxArgs[2]);
+  }
+
+  const linuxHome = toWslPath(process.env.USERPROFILE || os.homedir());
+  return spawnSync('wsl.exe', [
+    '--exec', 'env', `HOME=${linuxHome}`, toWslPath(linuxBinary), ...linuxArgs,
+  ], { stdio: 'inherit' });
+}
+
+function toWslPath(input) {
+  const gitBashPath = /^\/([a-zA-Z])\//.exec(input);
+  const windowsPath = gitBashPath
+    ? `${gitBashPath[1].toUpperCase()}:${input.slice(2)}`
+    : path.win32.resolve(input);
+  const converted = spawnSync('wsl.exe', ['--exec', 'wslpath', '-u', windowsPath], {
+    encoding: 'utf8',
+  });
+  if (converted.error || converted.status !== 0) {
+    throw new Error(converted.error?.message || converted.stderr?.trim() || 'wslpath could not convert the path');
+  }
+  return converted.stdout.replace(/\r?\n$/, '');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "keyman-cli",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Manage project .env files from one private YAML file",
   "license": "MIT",
   "repository": {
@@ -10,7 +10,8 @@
   "homepage": "https://github.com/moonmangit/keyman-cli#readme",
   "bugs": "https://github.com/moonmangit/keyman-cli/issues",
   "bin": {
-    "keyman": "bin/keyman.cjs"
+    "keyman": "bin/keyman.cjs",
+    "keyman-cli": "bin/keyman.cjs"
   },
   "files": [
     "bin/",