Commands and settings
Every command is in the Command Palette under Sync Servers, so everything works from the keyboard; the menus only add shortcuts to them. Run from the palette, a command acts on the active site, the file in the editor, or asks which site or server.
Commands
| Command | Does |
|---|---|
| Add Site | Asks for a new site's name, local folder, and first server's Protocol, Host, User and password, then connects and lets you pick the root directory from what the server shows. See Getting started. |
| Site Settings | Opens the settings form of a site. |
| Remove Site | Removes a site from the list after a question, and forgets its saved passwords. Its files are not touched. |
| Switch Site | Makes another site active in this window. |
| Open Site Folder | Opens a site's local folder as the workspace, here or in a new window. |
| Synchronize... | The dialog, then the Sync Preview. |
| Put | Uploads the file in the editor, the files chosen, or a whole site. |
| Get | Downloads them. |
| Compare with Remote | The server's copy beside the local file. |
| Cloak | Adds files and folders to the site's cloaked paths. |
| Uncloak | Takes them out again. |
| Global Cloaking Patterns... | Lists the cloaking patterns every site uses before its own, adds new ones, and removes one after a question. See Global cloaking patterns. |
| Test Connection | Connects, signs in and lists the root folder of a server. A failure offers its fix: Choose Folder, Sign In Again or Edit Host. |
| Set Password... | Asks for a server's password, or key passphrase, and keeps it in VS Code's secret storage. |
| Forget Password | Removes it. |
| Reset Sync Information | Forgets the sync records of a site and server after a question; the next sync compares both sides from scratch. |
| Show Log | Opens the Sync Servers log. |
While a preview waits
These join the palette while the Sync Preview holds a plan, and act on the rows chosen in it.
| Command | Does |
|---|---|
| Synchronize Checked Files | Runs the checked rows. |
| Check All | Checks every row that can be checked. |
| Uncheck All | Unchecks them. |
| Use Local | Puts the chosen rows. |
| Use Remote | Gets them. |
| Skip | Leaves them this time. |
| Mark Synchronized | Records both copies as in step without moving either. |
| Delete on Server | Deletes the server's copy of the chosen rows. |
| Delete Local File | Deletes the local copy, keeping it in the recovery folder while the site keeps recovery copies. |
| Close Preview | Closes the preview without moving anything. |
In the Remote Files view
These are in the palette while the Remote Files view has focus, and act on the entry chosen in it.
| Command | Does |
|---|---|
| Refresh Remote Files | Lists the open folders again. |
| Open Read-Only | The server's copy of a file in a read-only editor. |
| Delete on Server | Removes one file from the server after a question. |
Settings
| Setting | Default | Meaning |
|---|---|---|
syncServers.configDir | empty | The folder holding sites.json. Empty uses the command line's folder. It can be set in your user settings only, so a workspace can never point the extension at another list. |
syncServers.uploadOnSave.enabled | true | The one switch over every server's Upload on save. |
syncServers.preview.groupBy | action | Groups the Sync Preview by action or by folder. |
syncServers.confirmDeletes | true | Asks before any delete runs, in addition to the preview. |
syncServers.decorations.enabled | true | The Explorer marks for cloaked, changed and conflicting files. |
In Restricted Mode, a workspace's own values for syncServers.uploadOnSave.enabled and syncServers.confirmDeletes are ignored. Sites and servers are not VS Code settings: they live in the list of sites shared with the command line.