安装与接入

支持 Windows x86_64 和 Linux x86_64。公开包不含中心地址或 Key。安装 AI 先读 START_HERE.md,沿用用户已确定的模式和客户端,只补问缺失项。

选择方式

方式 需要什么 目录在哪里
本地独立使用 这台电脑及自己的 SSH 连接资料 本机 .sshmcp/servers.toml
接入已有中心 自己被授权的中心地址和 API Key,或已有有效 profile 中心权威目录,本机负责 SSH 和文件
部署自己的中心 明确的部署机器、访问地址和授权范围 先按 中心部署 完成服务,再接入本机

没有中心就选择本地模式;中心可没有公网 IP,但客户端必须能到达它。不要把下载站地址当作中心地址,也不要为接入已有中心重复部署服务。

校验并解压

下载 ZIP 及同名 .sha256。Linux 使用 sha256sum -c 文件名.zip.sha256;Windows 使用 Get-FileHash -Algorithm SHA256 -LiteralPath '实际 ZIP 路径',与校验文件比较。摘要不一致时重新获取可信完整包,不忽略校验继续安装。

解压后进入包含 START_HERE.md、linux-x86_64/ 和 windows-x86_64/ 的包根目录。两个平台脚本都会再次校验平台文件,再调用原生安装器。

本地独立使用

以下示例假设用户已经选择 Codex,它不是默认替用户选择的客户端。

Linux:

bash ./linux-x86_64/install.sh --local --clients codex

Windows PowerShell:

& .\windows-x86_64\Install.ps1 --local --clients codex

首次安装创建本机私密目录和空服务器目录。已有本地目录可通过 --local-config /实际绝对路径/servers.toml 复用;相应环境文件用 --env-file 指定。不要用空样例覆盖已有服务器。

接入已有中心

首次接入,将本地模式参数换为自己的 HTTPS 中心。下例地址仅为占位,必须换成被授权的真实地址;Key 在程序隐藏提示中输入。

Linux:

bash ./linux-x86_64/install.sh --endpoint https://center.example.com --clients codex

Windows PowerShell:

& .\windows-x86_64\Install.ps1 --endpoint https://center.example.com --clients codex

AI 无法操作隐藏输入时,使用用户已有的受限 Key 文件并加 --key-file,或使用自己的私有安装包。Key 不作为命令参数值、不贴进聊天、不上传网页。已有有效 .sshmcp/connection.json 时,普通升级直接复用,不必再次提供 endpoint/Key。

客户端名单

参数 接入范围
--clients codex 仅 Codex
--clients codex,snow 仅明确列出的两个客户端
--clients pi 仅 Pi;安装器检查其 MCP adapter,不安装 Pi 本身
--clients claude-code / claude-desktop 对应 Claude 客户端
--clients none 只安装程序,不修改客户端
--clients auto 仅在用户已选择全部已有受支持客户端时使用

安装器合并 SSHMCP 自己的条目并保留其他设置。程序按版本和哈希放入不可变目录,输出实际绝对路径。不要手动猜路径或清理正在使用的旧版本。

升级已有安装

从新版完整包运行平台脚本,保留原模式和明确选定的客户端。例如已选 Codex 的 Linux 电脑:

bash ./linux-x86_64/install.sh --clients codex

Windows 使用对应 Install.ps1 --clients codex。没有更新器的 5.1.x / 早期 6.0 客户端需首次完成这一步并重载 MCP。6.0.1 起中心模式默认启用自动更新,业务空闲后切换;详见 自动更新。

默认不新增系统启动项。需要常驻时再加 --startup login 或 --startup boot;boot 需要当前账户具备相应系统权限。普通使用不必以管理员/root 身份安装,也不必关闭安全软件或放宽全局 PowerShell 策略。

确认能用

  1. 检查安装输出的 success、installed_binary、profile、configured_clients 和 verification。若提示配置已保存但验证失败,保留备份,按错误继续排查。
  2. 用输出中的已安装程序执行 doctor --client-config <输出中的 profile 绝对路径>。不要把包内未安装的程序当作这一步的验收对象。
  3. 在所选客户端正常重载 MCP,再实际调用 ssh_list_servers;首次 count=0 正常。
  4. 用户提供服务器后,通过目录工具添加,再执行 hostname 等只读命令。工具用法见 AI_GUIDE.md。

安装器验证通过只证明安装后的新进程;用户已经打开的旧连接是否加载新版,仍须从那个客户端实际调用确认。安装器不会强制结束应用。