SFTP for Sublime Text

Remote/Server Settings

Server settings are changed by going to the File ▶ SFTP/FTP ▶ Edit Server menu and selecting a server.

Remote settings are changed by selecting the SFTP/FTP ▶ Edit Remote Mapping… menu when right clicking on a folder in the side bar, or editing the sftp-config.json file in your folder.

Tip: use the tab key to cycle through settings when first creating a config.

type

If the connection should use ftp, ftps or sftp. Changing this also automatically changes the port, if it is not specified.
Default: "sftp"

host

The domain name or IP address to connect to.
Default: "example.com"

user

The username to use when connecting to the host.
Default: "username"

password

The password to use. This is not necessary if using an sftp connection with SSH keys.
Default: ""

port

The port number to connect to. This is only necessary if using a non-standard port for the type specified. When creating an ftps connection, if the port is set to 990, an implicit SSL connection will be made, as opposed to the server and client negotiating the security.
Default: ""

remote_path

For the Remote workflow, the absolute path on the remote to map the current folder to. For the Server workflow, the default folder to display.
Default: "/example/path/"

file_permissions

The octal permissions to chmod files to. This should not start with a 0.
Default: ""

dir_permissions

The octal permissions to chmod folders to. This should not start with a 0.
Default: ""

extra_list_connections

The number of additional connections to create to the server when performing the list commands that are used to determine what operations should be performed during a sync. Adding extra connections can drastically improve the performance of sync for large folder trees.
Default: 0

connect_timeout

The number of seconds to timeout after when trying to connect.
Default: 30

keepalive

The number of seconds between sending a dummy command to the server to keep the connection open. For FTP connections, the command is NOOP, for SFTP connections, the command is cd .. Setting this to 0 disables keepalive commands.
Default: 0

ftp_passive_mode

If pasv mode should be used for the FTP connection. If the first upload to an FTP server takes a long time, try setting this to false. While this is not set explicitly by default in the plugin, the Python ftp library defaults to using passive mode.
Default: ""

ssh_key_file

The SSH private key file to use for an sftp connection. Linux and Mac will use the private key in ~/.ssh/ by default. On Windows this should be a .ppk file generated via Pageant.
Default: ""

sftp_sudo

If the sftp-server executable should be invoked on the server via sudo. This requires password-less sudo on the server being connected to, and requires the server be running Unix.
Default: false

sftp_debug

Sends the -v flag to the sftp binary when on Linux or Mac, or the psftp.exe binary when on Windows. Causes extra debug information to be displayed in the Sublime Text console.
Default: false

sftp_flags

Raw command line flags to send to the sftp binary when on Linux or Mac, or the psftp.exe binary when on Windows. Each flag should be a separate entry in the list.
Default: []

preserve_modification_times

If the modification times of files should be preserved when uploading and downloading. This setting may be false, true (for uploads and downloads) and "download_only". "download_only" may be required since this functionality is not available on all FTP servers.
Default: false

remote_time_offset_in_hours

The number of hours difference between the local machine and remote/server. This is normally determined automatically when connecting and should not normally need to be set.
Default: 0

remote_encoding

The remote encoding to use for unicode file paths. Normally this only needs to be adjusted for Windows FTP servers if using unicode file paths. See the python documentation for a valid list of encodings.
Default: "utf-8"

remote_locale

This settings is used to parse the last modified timestamps on remote files. Normally this should not need to be adjusted. Show valid locales

Valid Locales

• C
• af_ZA
• am_ET
• ast_ES
• bg_BG
• bn_BD
• bn_IN
• ca_ES
• cs_CZ
• cs_CZ2
• da_DK
• de_AT
• de_CH
• de_DE
• el_GR
• en_AU
• en_CA
• en_GB
• en_NZ
• en_US
• es_AR
• es_CL
• es_CO
• es_CR
• es_DO
• es_EC
• es_ES
• es_GT
• es_HN

• es_MX
• es_NI
• es_PA
• es_PE
• es_PR
• es_SV
• es_UY
• es_VE
• et_EE
• eu_ES
• fa_IR
• fi_FI
• fr_BE
• fr_CA
• fr_CH
• fr_FR
• gl_ES
• he_IL
• hr_HR
• hu_HU
• id_ID
• it_CH
• it_IT
• ja_JP
• km_KH
• ko_KR
• lt_LT
• lv_LV

• mk_MK
• ms_MY
• my_MM
• nb_NO
• nds_DE
• nl_BE
• nl_NL
• nn_NO
• pl_PL
• pt_BR
• pt_PT
• ro_RO
• ru_RU
• si_LK
• sk_SK
• sl_SI
• sq_AL
• sr_RS
• sv_SE
• ta_IN
• th_TH
• uk_UA
• ur_PK
• vi_VN
• zh_CN
• zh_HK
• zh_TW

Default: "C"

Remote Only Settings

The following settings are not applicable to the server workflow.

save_before_upload

A boolean (true or false) setting that controls whether or not files will be saved before uploading. This only affects files uploaded via the keyboard command.
Default: true

upload_on_save

If files should be automatically uploaded when saved. Files that match the ignore_regexes pattern are not automatically uploaded.
Default: false

sync_same_age

If files that are approximately the same age should be transfered when syncing. The FTP and SFTP protocols do not report modification time beyond the granularity of the minute, meaning that files that are the "same age" may, in fact, be different.
Default: true

sync_down_on_open

When a file is opened, the remote file modification time will be checked. If it is newer, the user will be prompted if they wish to download it.
Default: false

sync_skip_deletes

When performing Sync Up and Sync Down command, skip looking for files to delete.
Default: false

confirm_downloads

If a yes/no confirmation should be presented to the user when downloading a file or folder.
Default: false

confirm_sync

If a yes/no confirmation should be presented to the user when performing sync commands.
Default: true

confirm_overwrite_newer

If the user should be presented with a yes/no confirmation when uploading a file with a modification time that is older than the version of the file on the server. This only works when uploading individual files. Please note that setting this to true will have a slight affect on performance since a remote file listing will need to be performed on each file upload.
Default: false

ignore_regexes

A list of regular expressions to compare with file and folder paths to see if they should be ignored. The complete path to the file or folder will be compared to this regular expression. This uses the Python re module, and regular expression must be compatible with that. A literal backslash requires four backslashes since both JSON and regular expressions require backslashes to be escaped.
Default: ["\\.sublime-(project|workspace)", "sftp-config(-alt\\d?)?\\.json", "sftp-settings\\.json", "/venv/", "\\.svn", "\\.hg", "\\.git", "\\.bzr", "_darcs", "CVS", "\\.DS_Store", "Thumbs\\.db", "desktop\\.ini"]