Add "sysinfo" command that also displays the status of the 1Password integration

Author: skrysmanski

.vscode/settings.json

@@ -11,6 +11,7 @@
         "MD036": false,
     },
     "cSpell.words": [
-        "datadir"
+        "datadir",
+        "sysinfo"
     ]
 }

app/1Password.psm1

@@ -1,3 +1,9 @@
+#
+# Module for 1Password integration
+#
+# See: https://developer.1password.com/docs/ssh/get-started
+#
+
 # Stop on every error
 $script:ErrorActionPreference = 'Stop'
 
@@ -6,6 +12,7 @@ Import-Module "$PSScriptRoot/Utils.psm1"
 function Test-Is1PasswordIntegrationSupported() {
 	return Test-IsWindows -or $IsMacOs
 }
+Export-ModuleMember -Function Test-Is1PasswordIntegrationSupported
 
 function Test-Is1PasswordInstalled() {
 	if (-Not (Test-Is1PasswordIntegrationSupported)) {

app/SshEnvApp.ps1

@@ -12,6 +12,7 @@ Import-Module "$PSScriptRoot/SshEnvAppAux.psm1"
 Import-Module "$PSScriptRoot/Installation.psm1"
 Import-Module "$PSScriptRoot/SshDataDir.psm1"
 Import-Module "$PSScriptRoot/SshConfig.psm1"
+Import-Module "$PSScriptRoot/SysInfo.psm1"
 
 if ($args.Length -eq 0) {
 	Write-Help 'No command specified'
@@ -211,6 +212,11 @@ function Invoke-SshEnvApp {
 			break
 		}
 
+		'sysinfo' {
+			Write-SysInfo
+			break
+		}
+
 		'version|--version|-v' {
 			$version = Get-EnvVersion
 			Write-Host "ssh-env version $version"

app/SysInfo.psm1

@@ -0,0 +1,55 @@
+# Stop on every error
+$script:ErrorActionPreference = 'Stop'
+
+Import-Module "$PSScriptRoot/Utils.psm1"
+Import-Module "$PSScriptRoot/Installation.psm1"
+Import-Module "$PSScriptRoot/1Password.psm1"
+
+function Get-OperatingSystemName() {
+	if (Test-IsWindows) {
+		return 'Windows'
+	}
+	elseif ($IsMacOs) {
+		return 'macOS'
+	}
+	elseif ($IsLinux) {
+		return 'Linux'
+	}
+	else {
+		return 'unsupported'
+	}
+}
+
+function Get-1PasswordIntegrationStatus() {
+	if (-Not (Test-Is1PasswordIntegrationSupported)) {
+		return "unsupported operating system"
+	}
+
+	if (-Not (Test-Is1PasswordInstalled)) {
+		return "1Password not installed"
+	}
+
+	if (-Not (Test-Is1PasswordSshAgentEnabled)) {
+		return "1Password SSH agent not enabled"
+	}
+
+	return "1Password SSH agent enabled"
+}
+
+function Write-SysInfo() {
+	$osName = Get-OperatingSystemName
+	Write-Host "Operating System:       $osName"
+
+	if (Test-IsWindows) {
+		if (Test-IsMicrosoftSsh) {
+			Write-Host 'Use Microsoft SSH:      yes'
+		}
+		else {
+			Write-Host 'Use Microsoft SSH:      no'
+		}
+	}
+
+	$1passwordStatus = Get-1PasswordIntegrationStatus
+	Write-Host "1Password Intergration: $1passwordStatus"
+}
+Export-ModuleMember -Function Write-SysInfo

app/_HELP.txt

@@ -29,5 +29,6 @@ Commands:
   key load                   Loads your private key into the ssh-agent (so that it can be used
                              by applications other than ssh-env)
 
+  sysinfo                    Displays various information about the system
   help, --help, -h           Displays this help page
   version, --version, -v     Prints the ssh-env and OpenSSH client version