跳转至

VSCode SSH 插件使用教程

1. 安装 VSCode SSH 插件

  1. 打开 VSCode
  2. 点击左侧扩展图标（或按 Cmd+Shift+X）
  3. 在搜索框中输入 "Remote - SSH"
  4. 安装 "Remote - SSH" 插件（由 Microsoft 开发）

2. 配置 SSH 密钥

2.1 生成 SSH 密钥（如果还没有）

# 生成 SSH 密钥对
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

# 按回车接受默认文件位置（~/.ssh/id_rsa）
# 可以选择设置密码短语（推荐）或直接回车不设置

2.2 将公钥复制到服务器

# 方法 1：使用 ssh-copy-id（推荐）
ssh-copy-id username@remote_host

# 方法 2：手动复制
cat ~/.ssh/id_rsa.pub | ssh username@remote_host "mkdir -p ~/.ssh && cat >> ~/.ssh/authorized_keys"

3. 配置 SSH 配置文件

  1. 创建或编辑 SSH 配置文件：
# 创建配置文件
mkdir -p ~/.ssh
touch ~/.ssh/config
  1. 添加服务器配置：
Host server-name
    HostName your-server-ip
    User your-username
    Port 22
    IdentityFile ~/.ssh/id_rsa
    # 可选配置
    # ServerAliveInterval 60
    # ServerAliveCountMax 3

4. 使用 VSCode 连接服务器

4.1 快速调出方法（Mac）

  1. 使用快捷键：
  2. Cmd+Shift+P 打开命令面板
  3. 输入 "Remote-SSH" 可以看到所有相关命令

  4. 选择 "Remote-SSH: Connect to Host"

  5. 使用左侧活动栏：

  6. 点击左侧边栏的远程资源管理器图标（看起来像 "><" 的图标）
  7. 点击 "SSH TARGETS" 下的 "+" 号添加新连接

  8. 或直接点击已配置的服务器连接

  9. 使用状态栏：

  10. 点击 VSCode 窗口左下角的绿色图标
  11. 选择 "Connect to Host..."

4.2 首次连接步骤

  1. 在 VSCode 中：
  2. 按 Cmd+Shift+P 打开命令面板
  3. 输入 "Remote-SSH: Connect to Host"

  4. 选择配置的服务器

  5. 首次连接时：

  6. VSCode 会打开新窗口
  7. 选择服务器平台（Linux/Windows）
  8. 等待安装必要的组件

5. 常用功能

5.1 打开远程文件夹

  1. 连接成功后：
  2. 点击 "File" -> "Open Folder"
  3. 选择服务器上的文件夹
  4. 或使用快捷键 Cmd+K Cmd+O

5.2 使用集成终端

  1. 打开终端：
  2. 按 Cmd+` 或
  3. 点击 "Terminal" -> "New Terminal"
  4. 或使用快捷键 Cmd+Shift+ `

5.3 安装扩展

  1. 在远程会话中：
  2. 点击扩展图标
  3. 安装需要的扩展
  4. 某些扩展可能需要重新安装

6. 常见问题解决

6.1 连接失败

  1. 检查网络连接

  2. 验证 SSH 配置： 

    ssh -T username@remote_host

  3. 检查权限： 

    # 服务器端
chmod 700 ~/.ssh
chmod 600 ~/.ssh/authorized_keys

  4. Mac 特定问题：

  5. 检查 SSH 密钥权限： 
    chmod 600 ~/.ssh/id_rsa
chmod 644 ~/.ssh/id_rsa.pub
  6. 确保 SSH 代理正在运行： 
    eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_rsa

6.2 性能优化

  1. 在 ~/.ssh/config 中添加： 

    Host *
    ServerAliveInterval 60
    ServerAliveCountMax 3
    TCPKeepAlive yes

  2. 在 VSCode 设置中：

  3. 搜索 "remote.SSH.useLocalServer"

  4. 设置为 false 可能提高性能

  5. Mac 特定优化：

  6. 在 VSCode 设置中启用 "Remote.SSH: Enable Dynamic Forwarding"
  7. 使用 "Remote.SSH: Remote Server Listen On Socket" 设置

7. 最佳实践

  1. 使用 SSH 配置文件管理多个服务器
  2. 定期更新 SSH 密钥
  3. 使用 SSH 密钥而不是密码
  4. 保持 VSCode 和插件更新
  5. 使用 .gitignore 排除敏感文件
  6. 使用 SSH 配置文件别名简化连接

8. 安全建议

  1. 使用强密码保护 SSH 密钥
  2. 定期轮换 SSH 密钥
  3. 限制服务器 SSH 访问
  4. 使用非标准 SSH 端口
  5. 启用双因素认证（如果可能）
  6. 使用 SSH 密钥代理（ssh-agent）

9. 快捷键（Mac）

  • Cmd+Shift+P: 打开命令面板
  • Cmd+`: 打开/关闭终端
  • Cmd+Shift+F: 在远程文件夹中搜索
  • Cmd+Shift+E: 打开资源管理器
  • Cmd+Shift+X: 打开扩展面板
  • Cmd+K Cmd+O: 打开远程文件夹
  • Cmd+K Cmd+R: 重新打开远程窗口
  • Cmd+K Cmd+S: 保存所有文件
  • Cmd+K Cmd+T: 打开新终端
  • Cmd+K Cmd+W: 关闭远程窗口

10. 实用技巧

  1. 使用 SSH 配置文件别名： 

    Host dev
    HostName dev.example.com
    User developer
    Port 22
    IdentityFile ~/.ssh/id_rsa

  2. 快速切换服务器：

  3. 使用命令面板（Cmd+Shift+P）
  4. 输入 "Remote-SSH: Connect to Host"

  5. 选择目标服务器

  6. 在 Finder 中打开远程文件夹：

  7. 使用命令面板

  8. 输入 "Remote-SSH: Open Folder in Finder"

  9. 使用 SSH 隧道：

  10. 在 SSH 配置中添加端口转发
  11. 使用 VSCode 的端口转发功能
回到页面顶部