TMXIO SFTP
TMXIO SFTP is an independent, TMXIO-maintained distribution. It is not the original “SFTP” extension or SFTP Sync Plus.
A stable SFTP/FTP sync extension for modern VS Code, including VS Code 1.123+ and Node 24.
Sync files between a local folder and a remote server over SFTP/SSH or FTP/FTPS: upload on save, download, two-way sync, a remote file explorer, multiple profiles and more.
Status: maintenance mode. The extension is stable and feature-complete. TMXIO maintains security, compatibility, and critical bug fixes.
Maintained by TMXIO. Fork lineage: liximomo → Natizyskunk → SFTP Sync Plus → TMXIO SFTP. MIT licensed; the packaged NOTICE file records attribution.
How is TMXIO SFTP different?
This is a separate listing with its own name, icon, repository and maintainer. It exists to keep the tool alive on modern VS Code:
|
Original SFTP |
TMXIO SFTP |
| VS Code 1.123+ / Node 24 |
❌ crashes (isDate is not a function) |
✅ fixed |
| Maintenance |
stalled |
maintained by TMXIO |
| Extension ID |
Natizyskunk.sftp |
tmxio.tmxio-sftp |
| Release process |
legacy Marketplace release |
reviewed TMXIO VSIX release |
Your sftp.json |
— |
drop-in, no config changes |
Do not run multiple SFTP forks side by side because they intentionally preserve the same command and configuration IDs. Uninstall the previous extension before installing TMXIO SFTP.
Why this fork?
The widely-installed SFTP extensions stopped working on recent VS Code: on VS Code 1.123+ (which ships Node 24 via Electron) opening or saving a file over SFTP crashed with TypeError: isDate is not a function. Upstream is slow to update. This fork keeps it alive.
Fixed in v1.17.0
| Fix |
Detail |
✅ isDate is not a function on Node 24 |
Bumped ssh2 to ^1.17.0 (uses util.types.isDate). |
✅ Crash on connect ("listener" argument must be of type function) |
Disconnect handlers were registered incorrectly. |
| ✅ Source wouldn't recompile |
Fixed missing command-constant imports and a path-handling type bug. |
It is a drop-in replacement — your existing .vscode/sftp.json keeps working unchanged.
Table of contents
Features
- 📤 Upload files/folders/whole project — manually or automatically on save.
- 📥 Download files/folders/project from the server.
- 🔁 Sync Local→Remote, Remote→Local, or both directions.
- 🔍 Diff a local file against its remote version.
- 🗂️ Remote Explorer — browse, open, create and delete remote files from a sidebar.
- 👀 File watcher — react to external file changes.
- 👥 Multiple profiles (e.g. dev/prod) with one-click switching.
- 🪝 Connection hopping through one or more jump hosts.
- 🔑 Password, private key, SSH agent, and keyboard-interactive (2FA) auth.
- 🧩 Multiple contexts — map different local folders to different servers.
- 📄 Atomic / temp-file uploads to avoid serving half-written files.
Install
- Open Extensions (
Ctrl/Cmd + Shift + X).
- Uninstall
Natizyskunk.sftp, fibanez.sftp-sync-maintained, or any other SFTP fork to avoid duplicate commands.
- Search for TMXIO SFTP, or run
code --install-extension tmxio.tmxio-sftp.
- For an approved internal build, use Extensions → ··· → Install from VSIX… and select the release artifact.
- Reload VS Code. Existing
.vscode/sftp.json profiles are detected automatically.
Quick start
Open the local folder you want to sync.
Ctrl/Cmd + Shift + P → SFTP: Config. This creates .vscode/sftp.json.
Edit it with your server details:
{
"name": "My Server",
"host": "192.168.0.10",
"protocol": "sftp", // "sftp" (default) or "ftp"
"port": 22,
"username": "user",
"password": "secret", // optional — omit to be prompted
"remotePath": "/var/www/project",
"uploadOnSave": true // auto-upload every time you save
}
Save it. To pull an existing project down first, run SFTP: Download Project.
Edit locally — with uploadOnSave: true, every save syncs to the server.
Tip: leave password out and you'll be prompted securely instead of storing it in plain text. For keys, use privateKeyPath (see below).
Commands
Open the Command Palette (Ctrl/Cmd + Shift + P) and type SFTP, or right-click files/folders in the Explorer. Keybinding: Ctrl + Alt + U = Upload Changed Files.
Transfer
| Command |
What it does |
SFTP: Upload File / Upload Folder |
Upload the selected file/folder. |
SFTP: Upload Active File / Active Folder |
Upload the file/folder open in the editor. |
SFTP: Upload Project |
Upload the whole project to remotePath. |
SFTP: Upload Changed Files |
Upload files changed in Git (working tree / index). |
SFTP: Force Upload |
Upload ignoring timestamp checks. |
SFTP: Download File / Folder / Project |
Download from the server. |
SFTP: Download Active File / Active Folder |
Download what's open in the editor. |
SFTP: Force Download |
Download ignoring timestamp checks. |
… To All Profiles variants |
Run the upload against every profile at once. |
SFTP: Cancel All Transfers |
Abort in-flight transfers. |
Sync
| Command |
What it does |
SFTP: Sync Local -> Remote |
Make remote match local. |
SFTP: Sync Remote -> Local |
Make local match remote. |
SFTP: Sync Both Directions |
Two-way sync. |
Browse & compare
| Command |
What it does |
SFTP: Diff with Remote |
Diff a local file against its remote copy. |
SFTP: List / List Active Folder / List All |
List remote files. |
SFTP: Reveal in Remote Explorer |
Jump to a file in the Remote Explorer. |
SFTP: Edit in Local |
Open a remote-explorer file for local editing. |
SFTP: View Content |
Open a remote file read-only. |
SFTP: Refresh / Refresh Active Remote File |
Refresh the Remote Explorer. |
Remote management
| Command |
What it does |
SFTP: Create Folder / Create File |
Create on the server. |
SFTP: Delete |
Delete a remote file/folder. |
SFTP: Open SSH in Terminal |
Open an SSH session to the server. |
SFTP: Set Profile |
Switch the active profile. |
SFTP: Config |
Create/open sftp.json. |
Configuration reference
All settings live in .vscode/sftp.json. Below is every available option.
Connection
| Option |
Type |
Default |
Description |
name |
string |
— |
A label for this config (required for multi-context). |
host |
string |
localhost |
Server hostname or IP. |
port |
number |
22 (SFTP) / 21 (FTP) |
Server port. |
protocol |
"sftp" | "ftp" |
sftp |
Transfer protocol. |
username |
string |
— |
User for authentication. |
password |
string |
— |
Password. Omit to be prompted (avoids plaintext). |
remotePath |
string |
/ |
Absolute base path on the server. |
context |
string |
workspace root |
Local path (relative to workspace) this config maps to. |
connectTimeout |
number (ms) |
10000 |
How long to wait for the connection. |
SFTP authentication
| Option |
Type |
Default |
Description |
privateKeyPath |
string |
— |
Absolute path to your private key. |
passphrase |
string | true |
— |
Key passphrase. Set true to be prompted (no plaintext). |
agent |
string |
— |
Agent socket path, pageant, or 1password for the platform's standard 1Password endpoint. Supports ~ and $ENV_VAR. |
agentKeyPath |
string |
— |
Local public key used to select one identity from the agent and avoid server authentication-attempt limits. |
interactiveAuth |
boolean | string[] |
false |
Keyboard-interactive auth (e.g. 2FA / Google Authenticator). Pass an array to auto-answer prompts. |
sshConfigPath |
string |
— |
Absolute path to an SSH config file (e.g. ~/.ssh/config). |
algorithms |
object |
— |
Override transport algorithms: kex, cipher, serverHostKey, hmac (arrays). |
concurrency |
number |
— |
Number of concurrent operations. |
sshCustomParams |
string |
cd "${remotePath}"; exec $SHELL -l |
Extra params for Open SSH in Terminal. |
1Password SSH Agent
For a portable per-project configuration, enable the SSH Agent in 1Password and use:
{
"host": "production.example.com",
"username": "deploy",
"remotePath": "/var/www/project",
"agent": "1password",
"agentKeyPath": "~/.ssh/1Password/production.pub"
}
agentKeyPath must be a public key; the private key remains in 1Password. It is optional, but recommended when the agent exposes enough keys to hit a server's authentication-attempt limit.
The extension also honors IdentityAgent, IdentityFile, and IdentitiesOnly from ~/.ssh/config, including files brought in with Include and safe Host/Match rules. Explicit sftp.json values take precedence. This works with 1Password's generated SSH Bookmarks configuration:
Include ~/.ssh/1Password/config
Host *
IdentityAgent ~/.1password/agent.sock
On macOS, use 1Password's Group Container socket in IdentityAgent if you have not created the optional ~/.1password/agent.sock symlink. On Windows, 1Password uses the fixed Microsoft OpenSSH agent pipe, so "agent": "1password" needs no machine-specific path.
FTP / FTPS
| Option |
Type |
Default |
Description |
secure |
boolean | "control" | "implicit" |
false |
true = encrypt control+data; "control" = control only; "implicit" = implicit TLS (usually port 990). |
secureOptions |
object |
— |
Options passed to Node's tls.connect() (certs, CAs, ciphers, rejectUnauthorized, etc.). |
Transfer behavior
| Option |
Type |
Default |
Description |
uploadOnSave |
boolean |
false |
Upload automatically on every save. |
downloadOnOpen |
"confirm" | boolean |
"confirm" |
Download a file when opened. "confirm" asks first. |
useTempFile |
boolean |
false |
Upload to a temp file first, so visitors never hit a half-written file. |
openSsh |
boolean |
false |
Atomic uploads (OpenSSH servers only). Requires useTempFile: true. |
Sync behavior
Configure the Sync commands via syncOption:
| Option |
Type |
Default |
Description |
syncOption.delete |
boolean |
true |
Delete files at the destination that don't exist at the source. |
syncOption.skipCreate |
boolean |
true |
Don't create new files at the destination. |
syncOption.ignoreExisting |
boolean |
true |
Don't update files that already exist at the destination. |
syncOption.update |
boolean |
true |
Only overwrite when the source file is newer. |
Ignoring files
| Option |
Type |
Default |
Description |
ignore |
string[] |
[".vscode", ".git", ".DS_Store"] |
Glob patterns to skip (gitignore syntax). |
uploadIgnore |
string[] |
— |
Extra patterns skipped only when uploading (local ➞ remote), on top of ignore. |
downloadIgnore |
string[] |
— |
Extra patterns skipped only when downloading (remote ➞ local), on top of ignore. |
ignoreFile |
string |
.gitignore |
Path to an ignore file (absolute or relative to workspace). |
Remote Explorer options
| Option |
Type |
Default |
Description |
remoteExplorer.filesExclude |
string[] |
[] |
Patterns to hide in the Remote Explorer. |
remoteExplorer.order |
number |
0 |
Sort order (ascending; ties broken by name). |
Advanced
| Option |
Type |
Default |
Description |
watcher.files |
string (glob) |
**/* |
Files to watch for external changes. |
watcher.autoUpload |
boolean |
true |
Upload when a watched file changes. |
watcher.autoDelete |
boolean |
false |
Delete remote when a watched file is deleted. |
remoteTimeOffsetInHours |
number |
— |
Hour difference between local and server (remote − local). |
limitOpenFilesOnRemote |
number | true |
true |
Cap concurrent remote file descriptors (true = 222). Don't set unless you must. |
remote |
string |
— |
Pull config from a remotefs.remote entry in User Settings. |
defaultProfile |
string |
— |
Profile to activate by default. |
context and watcher are only valid at the root level.
Profiles
Define environments and switch between them with SFTP: Set Profile:
{
"username": "user",
"password": "secret",
"remotePath": "/remote/workspace/a",
"watcher": {
"files": "dist/*.{js,css}",
"autoUpload": false,
"autoDelete": false
},
"profiles": {
"dev": { "host": "dev-host", "remotePath": "/dev", "uploadOnSave": true },
"prod": { "host": "prod-host", "remotePath": "/prod" }
},
"defaultProfile": "dev"
}
Multiple contexts
Map different local folders to different servers. Each context must be unique, and name is required:
[
{
"name": "build",
"context": "project/build",
"host": "host", "username": "user", "password": "secret",
"remotePath": "/remote/project/build"
},
{
"name": "src",
"context": "project/src",
"host": "host", "username": "user", "password": "secret",
"remotePath": "/remote/project/src"
}
]
Connection hopping (jump host)
Reach a target server through one or more SSH proxies. (Variable substitution is not supported inside a hop config.)
Single hop — local → hop → target:
{
"name": "target",
"remotePath": "/path/in/target",
"host": "hopHost",
"username": "hopUser",
"privateKeyPath": "/Users/me/.ssh/id_rsa", // key lives on the local machine
"hop": {
"host": "targetHost",
"username": "targetUser",
"privateKeyPath": "/Users/hopUser/.ssh/id_rsa" // key lives on the hop
}
}
Multiple hops — local → hopA → hopB → target: pass hop as an array, each entry's key living on the previous host.
Config from User Settings (remote-fs)
Reuse a connection defined for remote-fs via the remote key.
User Settings:
"remotefs.remote": {
"dev": { "scheme": "sftp", "host": "host", "username": "user", "rootPath": "/path/to/somewhere" }
}
sftp.json:
{
"remote": "dev",
"remotePath": "/home/xx/",
"uploadOnSave": false
}
VS Code settings
Set these in your User/Workspace Settings (not sftp.json):
| Setting |
Default |
Description |
sftp.printDebugLog |
false |
Print debug logs to the SFTP output channel (reload after changing). |
sftp.debug |
false |
Enable debug logging (reload after changing). |
sftp.downloadWhenOpenInRemoteExplorer |
false |
Use Download instead of View Content when opening a file in the Remote Explorer. |
Remote Explorer
Browse the server from a dedicated sidebar:
- Run
View: Show SFTP, or click the SFTP icon in the Activity Bar.
- Files open read-only by default — run
SFTP: Edit in Local to edit one locally.
- Multi-select with
Ctrl/Shift to download/upload several items at once.
After deleting a file, manually refresh the parent folder if the view doesn't update.
Debugging
- Open Settings → set
sftp.debug to true → reload VS Code.
- View logs in View → Output → sftp.
When reporting an issue, this log (with secrets removed) is the most useful thing to include.
FAQ
The complete FAQ is maintained with the private TMXIO source repository.
Credits & license
Released under the MIT License included with the extension. Full credit to the maintainers in the fork lineage:
- liximomo — original extension.
- Natizyskunk — long-running maintained fork.
- fibanez7 — Node 24-compatible maintained fork used as the TMXIO baseline.
For support, contact your TMXIO account representative. Authorized maintainers use the private TMXIO GitLab issue tracker.