quick-ssh 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 CCE-Li
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Quick-SSH.psm1

@@ -0,0 +1,409 @@
+# Quick-SSH.psm1 - PowerShell SSH Connection Manager
+# 仿 Docker 命令行风格的 SSH 连接管理工具
+# 配置文件路径: %USERPROFILE%\.quickssh\hosts.json
+
+# ============================================================
+# 内部函数 - 配置管理
+# ============================================================
+
+$Script:ConfigDir   = Join-Path $env:USERPROFILE ".quickssh"
+$Script:ConfigFile  = Join-Path $Script:ConfigDir "hosts.json"
+$Script:ModuleRoot  = Split-Path -Parent $MyInvocation.MyCommand.Path
+$Script:TUIScript   = Join-Path $Script:ModuleRoot "qssh-tui.js"
+
+# 初始化配置目录和空 JSON 文件
+function Initialize-QuickSSHConfig {
+    if (-not (Test-Path $Script:ConfigDir)) {
+        New-Item -Path $Script:ConfigDir -ItemType Directory -Force | Out-Null
+    }
+    if (-not (Test-Path $Script:ConfigFile)) {
+        '[]' | Set-Content -Path $Script:ConfigFile -Encoding UTF8 -NoNewline
+    }
+}
+
+# 读取全部主机配置
+function Get-QuickSSHHosts {
+    Initialize-QuickSSHConfig
+    try {
+        $raw = Get-Content -Path $Script:ConfigFile -Raw -Encoding UTF8
+        if ([string]::IsNullOrWhiteSpace($raw)) { return @() }
+        $data = $raw | ConvertFrom-Json
+        # 兼容单个对象 { ... } 和数组 [{ ... }, { ... }]
+        if ($data -is [array]) { return $data }
+        return @($data)
+    } catch {
+        return @()
+    }
+}
+
+# 保存全部主机配置
+function Save-QuickSSHHosts($Hosts) {
+    $Hosts | ConvertTo-Json -Depth 10 | Set-Content -Path $Script:ConfigFile -Encoding UTF8
+}
+
+# ============================================================
+# 内部函数 - 颜色输出
+# ============================================================
+
+function Write-QSSuccess  { Write-Host $args[0] -ForegroundColor Green }
+function Write-QSWarning { Write-Host $args[0] -ForegroundColor Yellow }
+function Write-QSError   { Write-Host $args[0] -ForegroundColor Red }
+
+# ============================================================
+# 子命令实现
+# ============================================================
+
+# qssh ps [关键词] - 列出所有已保存的 SSH 连接
+function Invoke-QuickSSHPs {
+    param([string]$Keyword = "")
+
+    $hosts = Get-QuickSSHHosts
+    if ($hosts.Count -eq 0) {
+        Write-QSWarning "当前没有已保存的 SSH 连接。使用 'qssh add' 添加一个。"
+        return
+    }
+
+    if ($Keyword) {
+        $kw = $Keyword.ToLower()
+        $hosts = $hosts | Where-Object {
+            $_.alias.ToLower().Contains($kw) -or
+            $_.host.ToLower().Contains($kw)  -or
+            $_.user.ToLower().Contains($kw)
+        }
+        if ($hosts.Count -eq 0) {
+            Write-QSWarning "没有匹配 '$Keyword' 的 SSH 连接。"
+            return
+        }
+    }
+
+    $hosts | Format-Table -Property @(
+        @{ Label = "别名";     Expression = { $_.alias } },
+        @{ Label = "IP 地址";  Expression = { $_.host } },
+        @{ Label = "账号";     Expression = { $_.user } },
+        @{ Label = "端口";     Expression = { $_.port } },
+        @{ Label = "私钥路径"; Expression = { $_.key } }
+    ) -AutoSize
+}
+
+# qssh add [别名] [用户名@IP:端口] --key 私钥路径
+function Invoke-QuickSSHAdd {
+    param(
+        [string]$Alias,
+        [string]$UserAtHost,   # user@host 或 user@host:port
+        [string]$KeyPath = ""
+    )
+
+    if ((-not $Alias) -or (-not $UserAtHost)) {
+        Write-QSError "错误：用法 → qssh add <别名> <用户名@IP:端口> [--key <私钥路径>]"
+        return
+    }
+
+    # 解析 user@host:port
+    $user     = ""
+    $hostname = ""
+    $port     = 22
+
+    if ($UserAtHost -match '^(.+)@(.+):(\d+)$') {
+        $user     = $matches[1]
+        $hostname = $matches[2]
+        $port     = [int]$matches[3]
+    } elseif ($UserAtHost -match '^(.+)@(.+)$') {
+        $user     = $matches[1]
+        $hostname = $matches[2]
+    } else {
+        Write-QSError "错误：格式无效，请使用「用户名@主机:端口」或「用户名@主机」格式。"
+        return
+    }
+
+    if (-not $KeyPath) {
+        $KeyPath = Join-Path $env:USERPROFILE ".ssh" "id_rsa"
+    }
+
+    # 检查别名重复
+    $hosts    = Get-QuickSSHHosts
+    $existing = $hosts | Where-Object { $_.alias -eq $Alias }
+    if ($existing) {
+        Write-QSError "错误：别名 '$Alias' 已存在，请使用其他名称。"
+        return
+    }
+
+    $entry = @{
+        alias = $Alias
+        host  = $hostname
+        user  = $user
+        port  = $port
+        key   = $KeyPath
+    }
+    $hosts += $entry
+    Save-QuickSSHHosts $hosts
+
+    Write-QSSuccess "✔ 已添加 SSH 连接 '$Alias' → $user@$hostname`:$port"
+}
+
+# qssh rm [别名] - 删除指定别名的 SSH 连接
+function Invoke-QuickSSHRm {
+    param([string]$Alias)
+
+    if (-not $Alias) {
+        Write-QSError "错误：用法 → qssh rm <别名>"
+        return
+    }
+
+    $hosts  = Get-QuickSSHHosts
+    $target = $hosts | Where-Object { $_.alias -eq $Alias }
+    if (-not $target) {
+        Write-QSError "错误：别名 '$Alias' 不存在。使用 'qssh ps' 查看可用连接。"
+        return
+    }
+
+    $hosts = $hosts | Where-Object { $_.alias -ne $Alias }
+    Save-QuickSSHHosts $hosts
+
+    Write-QSSuccess "✔ 已删除 SSH 连接 '$Alias'。"
+}
+
+# qssh [别名] - 一键连接 SSH 服务器
+function Invoke-QuickSSHConnect {
+    param([string]$Alias)
+
+    if (-not $Alias) {
+        Invoke-QuickSSHTUI
+        return
+    }
+
+    $hosts  = Get-QuickSSHHosts
+    $target = $hosts | Where-Object { $_.alias -eq $Alias }
+    if (-not $target) {
+        Write-QSError "错误：别名 '$Alias' 不存在。使用 'qssh ps' 查看可用连接。"
+        return
+    }
+
+    $sshExe = if (Get-Command "ssh.exe" -ErrorAction SilentlyContinue) { "ssh.exe" } else { "ssh" }
+
+    $cmd = "$sshExe -i `"$($target.key)`" -p $($target.port) -o HostKeyAlgorithms=+ssh-rsa $($target.user)@$($target.host)"
+
+    Write-QSSuccess "正在连接到 '$Alias' ($($target.user)@$($target.host):$($target.port)) ..."
+    Write-Host ""
+
+    # 使用 cmd /c 避免 PowerShell 拦截 SSH 交互
+    $encoded = [Convert]::ToBase64String([Text.Encoding]::Unicode.GetBytes($cmd))
+    cmd /c "powershell -NoProfile -EncodedCommand $encoded"
+}
+
+# qssh export [文件路径] - 导出全部主机配置到 JSON 文件
+function Invoke-QuickSSHExport {
+    param([string]$FilePath)
+
+    if (-not $FilePath) {
+        Write-QSError "错误：用法 → qssh export <文件路径>"
+        return
+    }
+
+    $hosts = Get-QuickSSHHosts
+    if ($hosts.Count -eq 0) {
+        Write-QSWarning "没有可导出的 SSH 连接。"
+        return
+    }
+
+    $hosts | ConvertTo-Json -Depth 10 | Set-Content -Path $FilePath -Encoding UTF8
+    Write-QSSuccess "✔ 已导出 $($hosts.Count) 个连接到 '$FilePath'。"
+}
+
+# qssh import [文件路径] - 从 JSON 文件批量导入连接（自动去重）
+function Invoke-QuickSSHImport {
+    param([string]$FilePath)
+
+    if (-not $FilePath) {
+        Write-QSError "错误：用法 → qssh import <文件路径>"
+        return
+    }
+
+    if (-not (Test-Path $FilePath)) {
+        Write-QSError "错误：文件 '$FilePath' 不存在。"
+        return
+    }
+
+    try {
+        $imported = Get-Content -Path $FilePath -Raw -Encoding UTF8 | ConvertFrom-Json
+    } catch {
+        Write-QSError "错误：无法解析 JSON 文件，请检查格式。"
+        return
+    }
+
+    if ($imported.Count -eq 0) {
+        Write-QSWarning "文件中没有有效的连接配置。"
+        return
+    }
+
+    $existing = Get-QuickSSHHosts
+    $added   = 0
+    $skipped = 0
+
+    foreach ($h in $imported) {
+        $dup = $existing | Where-Object { $_.alias -eq $h.alias }
+        if (-not $dup) {
+            $existing += $h
+            $added++
+        } else {
+            $skipped++
+        }
+    }
+
+    Save-QuickSSHHosts $existing
+    Write-QSSuccess "✔ 导入完成：新增 $added 个，跳过 $skipped 个（别名重复）。"
+}
+
+# ============================================================
+# TUI 终端界面
+# ============================================================
+
+function Invoke-QuickSSHTUI {
+    # 检测 Node.js 是否可用
+    $nodePath = (Get-Command "node" -ErrorAction SilentlyContinue).Source
+    if (-not $nodePath) {
+        Write-QSError "错误：启动 TUI 需要 Node.js，请先安装 Node.js (https://nodejs.org)"
+        Write-QSError "或者使用命令行模式: qssh help"
+        return
+    }
+
+    if (-not (Test-Path $Script:TUIScript)) {
+        Write-QSError "错误：未找到 TUI 脚本: $Script:TUIScript"
+        return
+    }
+
+    # 启动 TUI，等待退出后返回
+    Write-Host "正在启动 Quick-SSH TUI ..." -ForegroundColor Cyan
+    & "node" $Script:TUIScript
+}
+
+# ============================================================
+# 帮助信息
+# ============================================================
+
+function Show-QuickSSHHelp {
+    Write-Host ""
+    Write-Host "Quick-SSH - PowerShell SSH 连接管理工具" -ForegroundColor Cyan
+    Write-Host ""
+    Write-Host "用法:" -ForegroundColor Yellow
+    Write-Host "  qssh                   启动 TUI 终端界面（推荐，类似 yazi 操作体验）"
+    Write-Host "  qssh ps [关键词]      列出所有已保存的 SSH 连接（对应 docker ps）"
+    Write-Host "  qssh add <别名> <用户@主机:端口> [--key <私钥路径>]" -ForegroundColor Gray
+    Write-Host "                        添加新 SSH 连接（端口默认 22，私钥默认 ~/.ssh/id_rsa）"
+    Write-Host "  qssh rm <别名>        删除指定别名的 SSH 连接（对应 docker rm）"
+    Write-Host "  qssh <别名>           一键连接 SSH 服务器"
+    Write-Host "  qssh export <文件>    导出全部主机配置到 JSON 文件"
+    Write-Host "  qssh import <文件>    从 JSON 文件批量导入连接"
+    Write-Host "  qssh help             显示本帮助信息"
+    Write-Host ""
+    Write-Host "示例:" -ForegroundColor Yellow
+    Write-Host "  qssh                         # 启动 TUI 界面"
+    Write-Host "  qssh ps"
+    Write-Host "  qssh ps 生产"
+    Write-Host "  qssh add my-server root@192.168.1.100:22 --key D:\.ssh\id_rsa"
+    Write-Host "  qssh add my-vm admin@10.0.0.5"
+    Write-Host "  qssh my-server"
+    Write-Host "  qssh rm my-vm"
+    Write-Host "  qssh export D:\backup\hosts.json"
+    Write-Host "  qssh import D:\backup\hosts.json"
+    Write-Host ""
+}
+
+# ============================================================
+# 主入口 - qssh 命令分发
+# ============================================================
+
+function global:qssh {
+    param(
+        [Parameter(Position = 0, Mandatory = $false)]
+        [string]$Command,
+
+        [Parameter(ValueFromRemainingArguments = $true)]
+        [string[]]$ArgsList
+    )
+
+    # 首次调用自动初始化
+    Initialize-QuickSSHConfig
+
+    if (-not $Command) {
+        Invoke-QuickSSHTUI
+        return
+    }
+
+    switch -Wildcard ($Command) {
+        "ps" {
+            $keyword = if ($ArgsList.Count -gt 0) { $ArgsList[0] } else { "" }
+            Invoke-QuickSSHPs -Keyword $keyword
+        }
+        "add" {
+            $alias      = $null
+            $userAtHost = $null
+            $keyPath    = $null
+            $i = 0
+            while ($i -lt $ArgsList.Count) {
+                if ($ArgsList[$i] -eq "--key" -or $ArgsList[$i] -eq "-k") {
+                    $i++
+                    if ($i -lt $ArgsList.Count) { $keyPath = $ArgsList[$i] }
+                } elseif (-not $alias) {
+                    $alias = $ArgsList[$i]
+                } elseif (-not $userAtHost) {
+                    $userAtHost = $ArgsList[$i]
+                }
+                $i++
+            }
+            Invoke-QuickSSHAdd -Alias $alias -UserAtHost $userAtHost -KeyPath $keyPath
+        }
+        "rm" {
+            $alias = if ($ArgsList.Count -gt 0) { $ArgsList[0] } else { "" }
+            Invoke-QuickSSHRm -Alias $alias
+        }
+        "export" {
+            $file = if ($ArgsList.Count -gt 0) { $ArgsList[0] } else { "" }
+            Invoke-QuickSSHExport -FilePath $file
+        }
+        "import" {
+            $file = if ($ArgsList.Count -gt 0) { $ArgsList[0] } else { "" }
+            Invoke-QuickSSHImport -FilePath $file
+        }
+        "help" {
+            Show-QuickSSHHelp
+        }
+        default {
+            # 未知命令当作别名尝试连接
+            Invoke-QuickSSHConnect -Alias $Command
+        }
+    }
+}
+
+# ============================================================
+# Tab 自动补全 - qssh 后按 Tab 可补全子命令和主机别名
+# ============================================================
+
+Register-ArgumentCompleter -CommandName "qssh" -ScriptBlock {
+    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameters)
+
+    $subCommands = @("ps", "add", "rm", "export", "import", "help")
+
+    # 获取已保存的主机别名
+    $aliases = @()
+    try {
+        $cfg = Join-Path $env:USERPROFILE ".quickssh" "hosts.json"
+        if (Test-Path $cfg) {
+            $raw = Get-Content -Path $cfg -Raw -Encoding UTF8
+            if ($raw) {
+                $hosts = $raw | ConvertFrom-Json
+                $aliases = @($hosts | ForEach-Object { $_.alias })
+            }
+        }
+    } catch {}
+
+    $allCompletions = $subCommands + $aliases
+    $allCompletions | Where-Object { $_ -like "$wordToComplete*" } | ForEach-Object {
+        [System.Management.Automation.CompletionResult]::new($_, $_, "ParameterValue", $_)
+    }
+}
+
+# ============================================================
+# 模块加载时自动导出 qssh 函数
+# ============================================================
+
+Export-ModuleMember -Function "qssh"

package/README.md

@@ -0,0 +1,224 @@
+# Quick-SSH 🚀
+
+> 仿 Docker 命令行风格的 PowerShell SSH 连接管理工具
+
+![License](https://img.shields.io/badge/license-MIT-green)
+![Platform](https://img.shields.io/badge/platform-Windows-blue)
+![PowerShell](https://img.shields.io/badge/PowerShell-5.1%2B-blue)
+
+一键保存、管理、连接 SSH 服务器，告别记忆繁琐的 IP、端口和密钥路径。
+
+---
+
+## 安装
+
+### 方式一：npm 全局安装（推荐）
+
+```powershell
+npm install -g quick-ssh
+```
+
+安装完成后，**重启 PowerShell 终端**即可使用 `qssh` 命令。
+
+> 安装脚本会自动将 `Import-Module` 写入你的 PowerShell 配置文件 (`$PROFILE`)，重启终端后永久生效。
+
+### 方式二：手动加载
+
+```powershell
+# 下载本仓库，在 Quick-SSH.psm1 所在目录执行：
+Import-Module .\Quick-SSH.psm1 -DisableNameChecking
+```
+
+---
+
+## 快速入门
+
+```powershell
+# 添加一个 SSH 连接
+qssh add my-server root@192.168.1.100:22 --key C:\Users\You\.ssh\id_rsa
+
+# 一键连接
+qssh my-server
+
+# 列出所有连接
+qssh ps
+
+# 删除连接
+qssh rm my-server
+```
+
+---
+
+## 命令参考
+
+### `qssh ps [关键词]`
+
+列出所有已保存的 SSH 连接（对应 `docker ps`）。
+
+| 列 | 说明 |
+|----|------|
+| 别名 | 连接的自定义名称 |
+| IP 地址 | 服务器主机名或 IP |
+| 账号 | 登录用户名 |
+| 端口 | SSH 端口（默认 22） |
+| 私钥路径 | 认证私钥文件路径 |
+
+**示例：**
+
+```powershell
+# 列出全部连接
+qssh ps
+
+# 筛选包含 "生产" 的连接
+qssh ps 生产
+
+# 无连接时的提示
+# → 当前没有已保存的 SSH 连接。使用 'qssh add' 添加一个。
+```
+
+### `qssh add <别名> <用户名@IP:端口> [--key <私钥路径>]`
+
+新增 SSH 连接记录（对应 `docker run` 的添加语义）。
+
+**参数说明：**
+
+| 参数 | 必填 | 默认值 | 说明 |
+|------|------|--------|------|
+| 别名 | ✅ | - | 连接的唯一标识名 |
+| 用户名@IP:端口 | ✅ | - | `root@192.168.1.100` 或 `root@192.168.1.100:2222` |
+| `--key` / `-k` | ❌ | `%USERPROFILE%\.ssh\id_rsa` | 私钥文件路径 |
+
+**示例：**
+
+```powershell
+# 使用默认端口 22 和默认密钥
+qssh add my-vm root@10.0.0.5
+
+# 指定端口和密钥
+qssh add prod-server deploy@192.168.1.100:2222 --key D:\keys\prod_id_rsa
+
+# 支持 -k 简写
+qssh add test-vm admin@172.16.0.10 -k C:\Users\Me\.ssh\test_rsa
+
+# 别名重复会报错
+# → 错误：别名 'my-vm' 已存在，请使用其他名称。
+```
+
+### `qssh rm <别名>`
+
+删除指定别名的 SSH 主机配置（对应 `docker rm`）。
+
+```powershell
+qssh rm my-vm
+# → ✔ 已删除 SSH 连接 'my-vm'。
+
+qssh rm unknown
+# → 错误：别名 'unknown' 不存在。使用 'qssh ps' 查看可用连接。
+```
+
+### `qssh <别名>`
+
+一键连接 SSH 服务器。自动读取保存的 IP、账号、端口、私钥发起会话。
+
+> 内置兼容老旧 `ssh-rsa` 密钥协商参数 `-o HostKeyAlgorithms=+ssh-rsa`，无需手动添加。
+
+```powershell
+qssh my-server
+# → 正在连接到 'my-server' (root@192.168.1.100:22) ...
+```
+
+### `qssh export <文件路径>`
+
+将全部主机配置导出到指定 JSON 文件。
+
+```powershell
+qssh export D:\backup\ssh-hosts.json
+# → ✔ 已导出 3 个连接到 'D:\backup\ssh-hosts.json'。
+```
+
+### `qssh import <文件路径>`
+
+从外部 JSON 文件批量导入连接，自动跳过别名重复的记录。
+
+```powershell
+qssh import D:\backup\ssh-hosts.json
+# → ✔ 导入完成：新增 5 个，跳过 2 个（别名重复）。
+```
+
+### `qssh help`
+
+显示帮助信息。
+
+---
+
+## Tab 自动补全
+
+输入 `qssh` 后按 <kbd>Tab</kbd> 键，可自动补全：
+
+- **子命令**：`ps`、`add`、`rm`、`export`、`import`、`help`
+- **已保存的主机别名**：快速选择要连接的服务器
+
+---
+
+## 配置文件
+
+所有连接数据存储在以下位置，**不会在卸载时删除**：
+
+```
+%USERPROFILE%\.quickssh\hosts.json
+```
+
+示例配置文件内容：
+
+```json
+[
+    {
+        "alias": "my-server",
+        "host": "192.168.1.100",
+        "user": "root",
+        "port": 22,
+        "key": "C:\\Users\\You\\.ssh\\id_rsa"
+    }
+]
+```
+
+---
+
+## 卸载
+
+```powershell
+npm uninstall -g quick-ssh
+```
+
+卸载时：
+- ✅ 自动从 `$PROFILE` 中移除 `Import-Module` 配置
+- ✅ **保留** `%USERPROFILE%\.quickssh\hosts.json` 用户配置数据
+
+---
+
+## 颜色输出说明
+
+| 颜色 | 含义 |
+|------|------|
+| 🟢 绿色 | 操作成功 |
+| 🟡 黄色 | 提示 / 警告 |
+| 🔴 红色 | 错误 |
+
+---
+
+## 项目文件结构
+
+```
+quick-ssh/
+├── Quick-SSH.psm1    # 核心 PowerShell 模块（全部逻辑）
+├── index.js           # npm 生命周期钩子（安装/卸载自动配置）
+├── package.json       # npm 包配置
+├── README.md          # 本文档
+└── LICENSE            # MIT 许可证
+```
+
+---
+
+## License
+
+[MIT](LICENSE)