SuperAPI AI 工具集

ssh-remote-connection

部署与运维

查看项目

更新于 10-15 12:34

技能介绍

用途

SSH Remote Connection 是一个用于通过 SSH 连接远程服务器的通用技能。它的设计目标是在需要操作远程服务器时提供便捷的连接与命令执行能力,典型用途包括:在远程服务器上执行命令、查看日志、重启服务、管理 Docker 容器。

主要能力

该技能提供两种使用形式:

  • 交互式 shell:通过 scripts/connect.sh 启动交互式连接。
  • 直接执行命令:通过 scripts/connect.sh "<命令>" 在远程服务器上直接运行指定命令。

常见命令示例(来自资料):

  • 查看日志:scripts/connect.sh "docker compose logs backend --tail 100"
  • 重启服务:scripts/connect.sh "docker compose restart backend"
  • 重新构建并重启:scripts/connect.sh "docker compose build backend && docker compose up -d backend"
  • 查看状态:scripts/connect.sh "docker compose ps"

使用方式

配置(适用于 Claude Code 本地环境)

  1. 复制配置模板:cp config/.env.example config/.env
  2. 在 config/.env 中填入实际值。

密钥认证示例配置:

SSH_HOST=your-server.example.com
SSH_USER=ubuntu
SSH_AUTH_METHOD=key
SSH_KEY_PATH=/absolute/path/to/private/key
SSH_KEY_PASSWORD=
SERVER_PROJECT_PATH=/path/to/project

密码认证示例配置:

SSH_HOST=your-server.example.com
SSH_USER=ubuntu
SSH_AUTH_METHOD=password
SSH_PASSWORD='your account password'
SERVER_PROJECT_PATH=/path/to/project
  1. 使脚本可执行:chmod +x scripts/connect.sh

配置(适用于 Cloud Runtime)

在云配置中设置以下环境变量:

  • SSH_HOST — 服务器主机名或 IP
  • SSH_USER — SSH 用户名
  • SSH_PORT — SSH 端口(可选)
  • SSH_AUTH_METHOD — auto、key 或 password(可选,默认 auto)
  • SSH_KEY_PATH — 密钥认证所用私钥路径
  • SSH_KEY_PASSWORD — 密钥口令(可选)
  • SSH_PASSWORD — 密码认证所用的 SSH 账号密码
  • SERVER_PROJECT_PATH — 服务器上的项目目录

适用场景

  • 需要在远程服务器上执行命令时。
  • 需要查看远程服务日志、重启服务时。
  • 需要管理远程 Docker 容器时。

限制与注意事项

  • 使用密码认证时,本地运行时必须安装 sshpass 或 expect。
  • 如果主机密钥尚未被信任,需要先手动连接一次,或将主机添加到 known_hosts,之后才能运行非交互式命令。
  • Git 操作:不要在服务器上运行 git pull,用户将手动处理 git 同步。
  • 代码位置:代码位于私有仓库,改动必须先推送,然后由用户拉取。
  • Docker:在服务器上使用 docker compose(而非 docker-compose)。
  • 关于收费、价格、平台支持范围、性能效果等信息,资料中暂未提供。