Simple SFTP Suzdalenko Dev

A simple SFTP client for Visual Studio Code.

Features

• Create an SFTP connection configuration.
• Download a complete remote project.
• Upload a file manually.
• Upload files automatically when they are saved.
• Ignore configured files and directories.
• View upload and download progress inside Visual Studio Code.

Installation

Install Simple SFTP Suzdalenko Dev from the Visual Studio Code Marketplace.

After installation, open the local folder where you want to download or manage your remote project:

File → Open Folder

How to use

1. Create the connection configuration

Open the Visual Studio Code Command Palette:

Ctrl + Shift + P

Run:

Simple SFTP: Config Connection

The extension creates and opens:

config/conn.json

Configure the SFTP connection:

{
  "host": "example.com",
  "port": 22,
  "username": "username",
  "password": "password",
  "remotePath": "/remote/project",
  "localPath": ".",
  "uploadOnSave": true,
  "ignore": [
    ".git",
    "node_modules",
    ".vscode",
    "config/conn.json"
  ]
}

Configuration properties:

• host: SFTP server hostname or IP address.
• port: SFTP port. The standard port is 22.
• username: SFTP username.
• password: SFTP password.
• remotePath: remote project directory.
• localPath: local directory relative to the open workspace.
• uploadOnSave: automatically uploads files when they are saved.
• ignore: files and directories excluded from uploads and downloads.

Save the configuration file.

2. Download the remote project

Open the Command Palette again:

Ctrl + Shift + P

Run:

Simple SFTP: Download Project

The extension downloads the files from remotePath into localPath.

Existing local files with the same path are updated. Local-only files are not deleted.

3. Edit and upload files automatically

When this option is enabled:

"uploadOnSave": true

edit a file and save it with:

Ctrl + S

The file is automatically uploaded to its corresponding remote path.

4. Upload a file manually

You can upload an individual file manually in any of these ways:

• Right-click the file in the VS Code Explorer.
• Right-click inside the open editor.
• Open the Command Palette with Ctrl + Shift + P.

Select:

Simple SFTP: Upload File

Available commands

Simple SFTP: Config Connection
Simple SFTP: Download Project
Simple SFTP: Upload File

Security notice

The connection password is currently stored as plain text inside:

config/conn.json

Do not commit this file to Git, publish it in a repository, or share it with other users.

The default ignore configuration excludes config/conn.json from SFTP synchronization.

Source code

The source code is available on GitHub:

https://github.com/suzdalenko-dev/simple-sftp-suzdalenko

License

MIT License

npx @vscode/vsce package