编辑
2026-04-29
工具与技术
00

目录

1. 文档目的
2. 适用场景
3. 环境要求
3.1 本地环境
3.2 服务器环境
4. 需要安装的 VS Code 扩展
5. 连接前准备
6. 配置 SSH 连接
6.1 打开远程连接入口(快速连接)
6.3 首次连接说明
6.4 打开 SSH 配置文件(自行配置)
6.5 配置示例
7. 打开远程目录
8. 常用操作
8.1 打开远程终端
8.2 编辑远程文件
8.3 安装远程环境扩展
9. 常见问题与排查
9.1 无法连接服务器

1. 文档目的

本文档用于说明如何使用 Visual Studio Code(以下简称 VS Code)远程连接 Linux 服务器,并在本地完成远程文件编辑、终端操作、代码运行与调试等开发工作。

2. 适用场景

  • 需要在本地电脑上开发或维护服务器中的代码
  • 服务器仅提供 SSH 登录方式
  • 希望使用 VS Code 的图形界面管理远程项目
  • 需要统一本地开发体验与远程运行环境

3. 环境要求

3.1 本地环境

  • 已安装 VS Code
  • 本地可以通过网络访问目标服务器
  • 已安装 OpenSSH 客户端

可在终端中执行以下命令检查 SSH 是否可用:

bash
ssh -V

3.2 服务器环境

  • 服务器已启动 SSH 服务
  • 拥有可登录服务器的用户名和密码,或 SSH 私钥
  • 当前用户具备目标目录的访问权限

4. 需要安装的 VS Code 扩展

在 VS Code 扩展市场中安装以下扩展:

  • Remote - SSH

通常安装 Remote Development 扩展包也可以,它会同时包含远程开发常用组件。

< img src="https://cdn.nlark.com/yuque/0/2026/png/58169839/1777375388210-1e6f668e-0ccd-4625-8965-41d92ac0f826.png" width="1200" title="" crop="0,0,1,1" id="u727a9cc6" class="ne-image">

5. 连接前准备

连接服务器前,需要确认以下信息:

  • 服务器 IP 地址或域名
  • SSH 端口,默认一般为 22
  • 登录用户名
  • 登录认证方式
    • 密码认证
    • 私钥认证

建议优先使用私钥认证,安全性更高。

6. 配置 SSH 连接

6.1 打开远程连接入口(快速连接)

< img src="https://cdn.nlark.com/yuque/0/2026/png/58169839/1777424099888-aaf1fd23-c3ea-4e5a-8639-52eb86ca8258.png" width="1200" title="" crop="0,0,1,1" id="u57478000" class="ne-image">

依次点击ssh插件,添加连接,输入 ssh 用户名@10.61.48.10,enter键后,出现

< img src="https://cdn.nlark.com/yuque/0/2026/png/58169839/1777424270935-17171f8f-959f-46f4-a421-ec05bd2f12a1.png" width="611" title="" crop="0,0,1,1" id="ua49a9cbf" class="ne-image">

点击第一个选择就将远程连接添加成功了,然后点击左侧的连接符号,输入密码就能连接成功了。

6.3 首次连接说明

首次连接时,VS Code 通常会执行以下动作:

  • 校验服务器指纹
  • 提示选择远程系统类型,例如 Linux
  • 在远程服务器上自动安装 VS Code Server

如果弹出认证提示:

  • 密码认证:输入服务器密码
  • 私钥认证:确保私钥路径和权限配置正确

连接成功后,左下角会显示当前远程连接状态。

6.4 打开 SSH 配置文件(自行配置)

在本地终端中编辑 SSH 配置文件:

bash
code ~/.ssh/config

如果文件不存在,可以手动创建。

6.5 配置示例

~/.ssh/config 中添加如下内容:

plain
Host my-server HostName 10.61.48.10 User lzb Port 22 IdentityFile ~/.ssh/id_rsa

字段说明:

  • Host:自定义连接名称,后续在 VS Code 中通过该名称连接
  • HostName:服务器 IP 或域名
  • User:登录用户名
  • Port:SSH 端口
  • IdentityFile:私钥文件路径,第一次添加远程主机先省略 IdentityFile

如果使用密码登录,可以先省略 IdentityFile

7. 打开远程目录

连接成功后:

  1. 打开命令面板
  2. 执行 Remote-SSH: Open Folder...
  3. 选择服务器上的目标项目目录

例如:

bash
/home/project/demo

打开后,VS Code 文件资源管理器中显示的是服务器上的文件,而不是本地文件。

8. 常用操作

8.1 打开远程终端

在 VS Code 中选择:

  • 菜单栏 Terminal -> New Terminal

此时打开的是服务器终端,可以直接执行远程命令,例如:

bash
pwd ls python3 app.py

8.2 编辑远程文件

直接在 VS Code 中打开并保存文件,修改会同步写入服务器。

8.3 安装远程环境扩展

某些扩展需要安装到远程服务器环境中,例如:

  • Python
  • Pylance
  • Docker

当 VS Code 检测到远程环境时,通常会提示安装到 SSH: my-server

9. 常见问题与排查

9.1 无法连接服务器

可先在本地终端测试 SSH:

bash
ssh my-server

如果终端也无法连接,重点检查:

  • IP 或域名是否正确
  • SSH 端口是否开放
  • 本地网络是否可以访问服务器
  • 服务器 SSH 服务是否正常运行

特别的,本文由Zhibo Lv提供,感谢他!

本文作者:ziqing luo

本文链接:

版权声明:本博客所有文章除特别声明外,均采用 BY-NC-SA 许可协议。转载请注明出处!