pro-deployer

PRO Deployer - Simple and powerful SFTP/FTP deployer. Support concurrency uploading or delete files (very fast uploading and deleting files or folders).

Features

• multiple targets
• switchable profiles
• upload on save
• auto-delete files or folders
• concurrency upload and delete files
• ignore list
• add Upload and Upload to buttons to a context menu
• support SSH keys
• support auto upload and remove files changed on disk, e.g triggered by another application
• support binary and ascii data transfer types
• support status bar item
• support quick pick dialog
• download files or folders from targets
• delete files or folders from targets
• diff tool: compare local file with remote file
• upload all open files
• upload all uncommitted files
• support workspaces! Now you can have multiple Pro Deployer configurations for each workspace. The first workspace folder is used for default configuration for UI/UX settings. All other settings will be used according to the active workspace. When use pro-deployer.upload-all-open or pro-deployer.download-all-files will be uploaded/downloaded files from the selected target workspace.
• upload to specific target via keybinding
• browse the remote file system to pick a target's dir (CodeLens above dir in the config or PRO Deployer: Browse Remote Directory...)
• dynamic configuration variables - use ${workspaceFolderBasename}, ${workspaceFolder}, ${userHome}, ${env:VAR} in configuration values

Donation

If you like this extension, you could become a backer or sponsor via PayPal. Any amount is welcome. It will encourage me to make this extension better and better!

Usage

1. Ctrl+Shift+P on Windows/Linux or Cmd+Shift+P on Mac open command palette, run PRO Deployer: Generate Config File.
2. Now you should have a new menu item PRO Deployer in the context menu of the file explorer or in opened files. Also, you can run commands from the command palette. If you is enabled uploadOnSave option, on file save will be uploaded automatically.
3. Enjoy.

Keyboard Shortcuts

1. Alt+U - upload file
2. Alt+D - download file

Upload to Specific Target via Keybinding

You can bind a specific target to a keyboard shortcut by passing the target argument to the pro-deployer.upload-to command in your keybindings.json.

{
    "key": "ctrl+alt+1",
    "command": "pro-deployer.upload-to",
    "args": { "target": "My SFTP" }
},
{
    "key": "ctrl+alt+2",
    "command": "pro-deployer.upload-to",
    "args": { "target": "My FTP" }
}

Example Configs

Config file location: ${workspaceFolder}/.vscode/pro-deployer.json

Variable Substitution

PRO Deployer supports VS Code-like variables in configuration values. This is useful for creating dynamic configurations that adapt to different workspaces.

Supported Variables:

Example with dynamic directory:

{
    "targets": [
        {
            "name": "My SFTP",
            "type": "sftp",
            "host": "example.com",
            "user": "admin",
            "password": "123456",
            "dir": "/var/www/${workspaceFolderBasename}"  // Uses workspace folder name
        }
    ]
}

This allows you to use the same configuration template across multiple workspaces, and the dir will automatically resolve to the workspace folder name (e.g., /var/www/my-project).

Secrets (keychain)

Instead of a clear-text password or passphrase, store the value in the OS keychain and reference it by name:

1. Run PRO Deployer: Set Secret (keychain) and enter a name (e.g. my-sftp) and the value.
2. Reference it in the config:

{
    "password": "${secret:my-sftp}",
    "passphrase": "${secret:my-key}"
}

• ${secret:NAME} is resolved only in the password and passphrase options.
• Secrets are stored per machine and are not synced or written to the config file.
• Run PRO Deployer: Delete Secret (keychain) to remove one. A missing secret resolves to an empty value and a warning is written to the output channel.
• Clear-text passwords keep working. Passwords are never written to the output channel.

Full Configuration Example

{
    "enableStatusBarItem": true, //enable extension status bar item
    "enableQuickPick": true, //enable quick pick when upload/error occurs
    "uploadOnSave": true, //on file change will be uploaded to active targets
    "autoDelete": true, //on file delete will be deleted to active targets
    "checkGitignore": false, //skip files that are ignored in .gitignore
    "respectIgnoreOnDownload": false, //skip ignored files/folders when downloading directories
    "activeTargets": [
        "My SFTP"
    ],
    "concurrency": 5, //maximum number of concurrent actions (upload/delete)
    "ignore": [
        ".git/**/*",
        ".vscode/**/*"
    ],
    "include": [], // This option allows you to specify which files/folders to include in the auto upload/delete. If this option is not specified, all files/folders will be included.
    "targets": [
        {
            "name": "My SFTP",
            "type": "sftp",
            "host": "localhost",
            "port": 22,
            "user": "admin",
            "password": "123456",
            "dir": "/public_html",
            "baseDir": "/", //This option is useful when you want to upload files from a subdirectory of the project
            "privateKey": null,
            "passphrase": null,
            "useAuthAgent": false, //Set to true to enable authentication over SSH agent
            "authAgentPath": null, //Path of the SSH agent socket. If not set, it falls back to ${env:SSH_AUTH_SOCK}
            "hostFingerprint": null, //Optional host key fingerprint (e.g. "SHA256:..."); the connection is refused on mismatch
            "keepaliveIntervalMs": 10000, //Optional keepalive interval (ms)
            "preserveMtime": false //Set the remote modification time to the local one after upload
        },
        {
            "name": "My FTP",
            "type": "ftp",
            "host": "localhost",
            "port": 21,
            "user": "admin",
            "password": "123456",
            "dir": "/public_html",
            "baseDir": "/", //This option is useful when you want to upload files from a subdirectory of the project
            "transferDataType": "binary",
            "secure": false, //Set to true for explicit FTPS (AUTH TLS) or "implicit" for implicit FTPS (port 990)
            "secureOptions": {
                "rejectUnauthorized": true //Defaults to true; set to false only for servers with a self-signed certificate
            },
            "keepaliveIntervalMs": 10000, //Optional keepalive interval (ms)
            "preserveMtime": false //Set the remote modification time to the local one after upload (requires MFMT support on the server)
        }
    ]
}

FTP Target Options

SFTP Target Options

Extension Commands

This extension contributes the following commands:

• pro-deployer.generate-config-file: auto generate config file
• pro-deployer.upload: upload file or folder
• pro-deployer.upload-to: upload file or folder to selected target
• pro-deployer.download: download file or folder
• pro-deployer.download-from: download file or folder from selected target
• pro-deployer.delete: delete file or folder from active targets
• pro-deployer.delete-from: delete file or folder from selected target
• pro-deployer.diff-with: compare local file with remote file
• pro-deployer.browse-remote-dir: browse the remote file system and save the selected directory as a target's dir
• pro-deployer.upload-all-open: upload all open files
• pro-deployer.show-output-channel: show output channel of PRO Deployer
• pro-deployer.set-secret: store a password/passphrase in the OS keychain
• pro-deployer.delete-secret: remove a stored secret
• pro-deployer.cancel-all-actions: stop all actions (uploads, downloads, deletes) and remove all actions from queue
• pro-deployer.upload-all-uncommitted: upload all uncommitted files