code review

Author: flakey5

packages/wrangler/src/__tests__/containers/ssh.test.ts

@@ -39,17 +39,15 @@ describe("containers ssh", () => {
 			  -v, --version   Show version number  [boolean]
 
 			OPTIONS
-			      --cipher         SSH option for cipher_spec (-c)  [string]
-			      --log-file       SSH option for log_file (-c)  [string]
-			      --escape-char    SSH option for escape_char (-e)  [string]
-			      --config-file    SSH option for config-file (-F)  [string]
-			      --pkcs11         SSH option for pkcs11 (-I)  [string]
-			      --identity-file  SSH option for identity_file (-i)  [string]
-			      --mac-spec       SSH option for mac_spec (-m)  [string]
-			      --ctl-cmd        SSH option for ctl_cmd (-O)  [string]
-			      --option         SSH option for option (-o)  [string]
-			      --tag            SSH option for tag (-P)  [string]
-			      --ctl-path       SSH option for ctl_path (-S)  [string]"
+			      --cipher         SSH option: Selects the cipher specification for encrypting the session  [string]
+			      --log-file       SSH option: Append debug logs to log_file instead of standard error  [string]
+			      --escape-char    SSH option: Sets the escape character for sessions with a pty (default: ‘~’)  [string]
+			      --config-file    SSH option: Specifies an alternative per-user configuration file  [string]
+			      --pkcs11         SSH option: Specify the PKCS#11 shared library ssh should use to communicate with a PKCS#11 token providing keys for user authentication  [string]
+			      --identity-file  SSH option: Selects a file from which the identity (private key) for public key authentication is read  [string]
+			      --mac-spec       SSH option: A comma-separated list of MAC (message authentication code) algorithms, specified in order of preference  [string]
+			      --option         SSH option: Can be used to give options in the format used in the configuration file  [string]
+			      --tag            SSH option: Specify a tag name that may be used to select configuration in ssh_config(5)  [string]"
 		`);
 	});
 

packages/wrangler/src/containers/containers.ts

@@ -167,47 +167,48 @@ export function sshYargs(args: CommonYargsArgv) {
 			})
 			// Following are SSH flags that should be directly passed in
 			.option("cipher", {
-				describe: "SSH option for cipher_spec",
+				describe:
+					"SSH option: Selects the cipher specification for encrypting the session",
 				type: "string",
 			})
 			.option("log-file", {
-				describe: "SSH option for log_file",
+				describe:
+					"SSH option: Append debug logs to log_file instead of standard error",
 				type: "string",
 			})
 			.option("escape-char", {
-				describe: "SSH option for escape_char",
+				describe:
+					"SSH option: Sets the escape character for sessions with a pty (default: ‘~’)",
 				type: "string",
 			})
 			.option("config-file", {
-				describe: "SSH option for config-file",
+				describe:
+					"SSH option: Specifies an alternative per-user configuration file",
 				type: "string",
 			})
 			.option("pkcs11", {
-				describe: "SSH option for pkcs11",
+				describe:
+					"SSH option: Specify the PKCS#11 shared library ssh should use to communicate with a PKCS#11 token providing keys for user authentication",
 				type: "string",
 			})
 			.option("identity-file", {
-				describe: "SSH option for identity_file",
+				describe:
+					"SSH option: Selects a file from which the identity (private key) for public key authentication is read",
 				type: "string",
 			})
 			.option("mac-spec", {
-				describe: "SSH option for mac_spec",
-				type: "string",
-			})
-			.option("ctl-cmd", {
-				describe: "SSH option for ctl_cmd",
+				describe:
+					"SSH option: A comma-separated list of MAC (message authentication code) algorithms, specified in order of preference",
 				type: "string",
 			})
 			.option("option", {
-				describe: "SSH option for option",
+				describe:
+					"SSH option: Can be used to give options in the format used in the configuration file",
 				type: "string",
 			})
 			.option("tag", {
-				describe: "SSH option for tag",
-				type: "string",
-			})
-			.option("ctl-path", {
-				describe: "SSH option for ctl_path",
+				describe:
+					"SSH option: Specify a tag name that may be used to select configuration in ssh_config(5)",
 				type: "string",
 			})
 	);