@pixlcore/xyplug-ssh 1.0.0 → 1.0.2

package/README.md

@@ -50,6 +50,7 @@ The plugin also exports a few helper variables remotely:
 - `SSH Hostname`: Hostname or IP address
 - `Username`: SSH username
 - `Port`: SSH port
+- `Private Key File`: Optional path to private key on disk.
 - `Host Fingerprint`: Optional host key pin, recommended for production
 - `Connect Timeout`: SSH connect timeout in seconds
 - `Remote Env`: Extra key/value pairs to pass to the remote side

package/index.js

@@ -4,6 +4,7 @@
 // Copyright (c) 2026 PixlCore LLC
 // MIT License
 
+const fs = require('fs');
 const { createHash } = require('crypto');
 const { Client } = require('ssh2');
 
@@ -36,7 +37,7 @@ const app = {
 			String(this.params.username || '').trim(),
 			this.params.port
 		);
-		const auth = resolveAuth(secrets);
+		const auth = resolveAuth(this.params, secrets);
 		const remoteCommand = String(this.params.remote_command || '').trim();
 		if (!remoteCommand) fatal('params', "Required parameter 'remote_command' was not provided.");
 		
@@ -226,12 +227,20 @@ function parseTarget(hostname, username, portFallback) {
 	return { host, port, username: user };
 }
 
-function resolveAuth(secrets) {
-	const privateKey = resolveNamedValue('SSH_PRIVATE_KEY', secrets);
+function resolveAuth(params, secrets) {
+	let privateKey = resolveNamedValue('SSH_PRIVATE_KEY', secrets);
 	const passphrase = resolveNamedValue('SSH_PASSPHRASE', secrets);
 	const password = resolveNamedValue('SSH_PASSWORD', secrets);
 	const agent = process.env.SSH_AUTH_SOCK || '';
 	
+	// private key may be specified as a file path in params
+	if (params.private_key_file) {
+		try { privateKey = fs.readFileSync(params.private_key_file, 'utf8'); }
+		catch (err) {
+			fatal( 'auth', 'Failed to read private key file: ' + params.private_key_file + ": " + err );
+		}
+	}
+	
 	if (!privateKey && !password && !agent) {
 		fatal(
 			'auth',

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pixlcore/xyplug-ssh",
-	"version": "1.0.0",
+	"version": "1.0.2",
 	"description": "An SSH runner plugin for the xyOps workflow automation system.",
 	"author": "Joseph Huckaby <jhuckaby@pixlcore.com>",
 	"homepage": "https://github.com/pixlcore/xyplug-ssh",

package/xyops.json

@@ -10,7 +10,7 @@
 				"title": "Remote SSH",
 				"enabled": true,
 				"type": "event",
-				"command": "npx -y @pixlcore/xyplug-ssh@1.0.0",
+				"command": "npx -y @pixlcore/xyplug-ssh@1.0.2",
 				"script": "",
 				"kill": "parent",
 				"runner": true,
@@ -30,7 +30,7 @@
 						"title": "Username",
 						"type": "text",
 						"value": "",
-						"caption": "SSH username to connect with.",
+						"caption": "The SSH username to connect with.",
 						"required": true
 					},
 					{
@@ -39,7 +39,14 @@
 						"type": "text",
 						"variant": "number",
 						"value": 22,
-						"caption": "SSH TCP port."
+						"caption": "The SSH TCP port (usually `22`)."
+					},
+					{
+						"id": "private_key_file",
+						"title": "Private Key File",
+						"type": "text",
+						"value": "",
+						"caption": "Optional: If your SSH private key is stored on disk, you can enter the path to it here.  Otherwise, use a secret vault."
 					},
 					{
 						"id": "host_fingerprint",