VScode实现本地与远端同步开发

蓝田心语

已于 2025-03-07 16:59:30 修改

阅读量1w

点赞数 12

分类专栏：服务器文章标签： vscode 服务器 ide

于 2023-04-24 19:10:53 首次发布

本文链接：https://blog.csdn.net/zht2002/article/details/130349227

版权

服务器专栏收录该内容

4 篇文章

订阅专栏

本文介绍了如何在VScode中通过安装SFTP插件实现本地代码与服务器端代码的双向同步。配置包括安装SFTP扩展，设置sftp.json文件以连接服务器，并设置自动或手动同步选项。此外，还讲解了如何通过远程资源管理器查看和同步服务器端的代码到本地。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

有时候希望在本地修改的代码能够直接同步到服务器端，或者在服务器端的代码能够直接同步到本地端，本文介绍如何实现VScode的本地代码和服务器端代码的同步

1. 在VScode中安装SFTP插件

直接在扩展程序处搜索"SFTP",安装这个插件

2.用VScode打开你想要同步的那份代码所在的文件夹

比如我现在想要同步src这个文件夹中的代码

3. Ctrl+shift+P唤醒VScode命令行，输入SFTP:config,点击这个。

vscode会自动在当前文件夹(src)下创建一个.vscode文件夹，里面有一个sftp.json文件，其内容为：

{
    "name": "MyServer",
    "host": "your default host",
    "protocol": "sftp",
    "port": 22,
    "username": "xxx",
    "remotePath": "your default remote path",
    "privateKeyPath": "~/.ssh/id_rsa",
    "uploadOnSave": false,
    "useTempFile": false,
    "openSsh": false,
    "ignore": [
        "**/.git",
        "**/checkpoints",
        "**/.vscode",
        "**/__pycache__",
        "**/output",
        "**/wandb",
        "**/reorder"
    ],
    "profiles": {
        "Server1": {
          "name": "Server1",
          "host": "aaa",
          "username": "aaa",
          "remotePath": "aaa"
        },
        "Server2": {
          "name": "Server1",
          "host": "bbb",
          "username": "bbb",
          "remotePath": "bbb"
        }
      }
}

参数解释：

name：你为这个sftp的连接起一个命名
host：目标主机IP地址，需自己查看并填写（先确保远端开启了sftp服务）
protocol：传输协议，sftp，不需要改动
port：传输端口，默认22，不需要改动
username：登录的用户名，需自己确认
password：若不想每次登录输入密码，可以增加此字段，硬编码进去
privateKeyPath：本地私钥，与password选用一个就好
remotePath：远端同步的路径
uploadOnSave：当你按下 ctrl + s 时，自动同步代码到远端服务器
ignore：不需要同步的目录or文件, 其中*** 表示所有目录， ***/.git 表示所有目录下的.git文件都不进行同步

profiles配置了2个服务器，等后面你要同步的时候你可以自己挑选使用哪个服务器

填入相应内容，保存。

上面的选项里的“uploadOnSave”：表示每当你保存时就会自动将本地代码同步到服务器端。如果是false，就需要手动进行同步操作

tips:这里有一个非常值得注意的点，就是remotePath要填入远程服务器端要同步你的代码的地址，