VSCode需通过SFTP扩展实现远程同步,推荐使用Arjun Komath维护的liximomo.sftp;安装后须打开工作区,配置正确sftp.json(含host、port、username、remotePath),上传前确保远程目录存在。

VSCode 本身不内置 SFTP 功能,必须依赖扩展实现远程文件同步;最常用、维护活跃、支持主流协议的是 ftp-simple 和 SFTP(由 Arjun Komath 维护,ID:liximomo.sftp)。后者更稳定、配置更清晰,推荐优先使用。
安装并启用 SFTP 扩展
在 VSCode 扩展市场搜索 SFTP,认准发布者为 Arjun Komath、ID 是 liximomo.sftp 的那个——注意别选错成已停更的旧版(如 npmi.sftp 或名字相近但无持续更新的)。安装后无需重启,但需确保当前工作区已打开(即有文件夹被加载),否则右键菜单里的 Upload/Download 选项不会出现。
常见错误现象:
- 右键没有
Upload to SFTP Server:说明未打开文件夹,或扩展未激活(检查左下角状态栏是否有SFTP图标) - 安装后命令面板(
Ctrl+Shift+P)搜不到SFTP相关命令:重启 VSCode 或重载窗口(Cmd/Ctrl+Shift+P → Developer: Reload Window)
配置 sftp.json 连接远程服务器
在当前工作区根目录下新建 .vscode/sftp.json(路径必须准确),内容需包含至少 host、port、username、remotePath 四项。密码可留空(后续会弹窗输入),但建议用密钥认证避免反复输密码。
关键参数说明:
-
protocol:默认sftp,不要改成ftp或ftps,否则连接失败 -
remotePath:必须以/开头,且是远程服务器上的绝对路径(如/var/www/html),不是相对路径 -
uploadOnSave:设为true后,本地保存文件自动上传;但仅对已映射到该配置的文件生效(即文件路径匹配files规则,或位于remotePath对应的本地子目录) -
ignore:数组形式,填 glob 模式,如["**/.git/**", "**/node_modules/**"],防止上传无关文件
{
"name": "Production Server",
"host": "192.168.1.100",
"port": 22,
"username": "deploy",
"remotePath": "/var/www/myapp",
"uploadOnSave": true,
"ignore": ["**/.git/**", "**/dist/**"]
}
上传/下载文件与文件夹的正确操作方式
右键菜单是最直接的方式,但行为取决于你右键的对象和当前配置是否匹配:
- 右键一个本地文件 → 出现
Upload to SFTP Server:上传该文件到remotePath下对应路径(如本地src/index.js会传到远程/var/www/myapp/src/index.js) - 右键一个本地文件夹 → 只有
Upload Folder to SFTP Server:上传整个文件夹(含子目录),目标路径是remotePath+ 文件夹名 - 右键远程资源管理器中的文件 →
Download from SFTP Server:下载单个文件;但该面板默认不显示,需先通过SFTP: Connect命令连接成功才会出现
注意:SFTP 扩展不会自动创建远程缺失的父目录。如果上传 src/utils/helper.js,而远程 /var/www/myapp/src/utils/ 不存在,会报错 No such file。此时需手动创建,或改用 SFTP: Upload Folder(它会递归建目录)。
调试连接失败的几个关键点
连接超时、权限拒绝、无法列出目录是最常遇到的问题,排查顺序建议如下:
- 确认远程服务器 SSH 正在运行:
ssh deploy@192.168.1.100能否正常登录?不能则先解决网络或 SSH 配置 - 检查用户权限:该用户是否对
remotePath有读写权限?ls -ld /var/www/myapp看属主和权限位 - 验证密钥格式:若用私钥,确保是 OpenSSH 格式(
-----BEGIN OPENSSH PRIVATE KEY-----),不是 PuTTY 的.ppk;可用ssh-keygen -p -f key.pem转换 - 查看输出面板:
Ctrl+Shift+U打开输出面板 → 左上角下拉选SFTP,所有连接日志、错误详情都在这里,比弹窗提示更具体
特别容易忽略的一点:Windows 用户若用 WSL 作为本地开发环境,sftp.json 中的 remotePath 是远程 Linux 路径,但本地路径映射仍按 Windows 规则解析——除非你在 WSL 内启动 VSCode(用 code .),否则路径逻辑可能错乱。










