Repository navigation
Best Practices
github-actions[bot] edited this page Oct 8, 2026
·
1 revision
A few habits that'll save you a bad afternoon:
-
password/passphrasesit insftp.jsonas plain text, so don't commit that file if it has either — put it in.gitignore, and use secret storage or key-based auth (privateKeyPath/agent) instead where you can. - Add the obvious noise to
ignore—/.git,/.vscode,node_modules, build caches,.DS_Store. Faster transfers, and you're not cluttering the server with things it doesn't need. The Force commands cover the rare exception. - Before running a folder upload/Sync on a project you don't fully know, set
maxFileSize— otherwise the first sign of that stray database dump or.isoin the tree is the transfer still running twenty minutes later. - On a live site, turn on
useTempFile(andopenSshif the server supports it) so nobody ever loads a half-written file mid-deploy. - Don't run
uploadOnSaveand a broadwatcher("**/*"+autoUpload) at the same time — that's just double uploads for no reason, pick one. -
syncOption.deleteandwatcher.autoDeleteactually remove things on the other end, so keepsyncConfirmon (it already defaults on wheneverdeleteis) and run Compare Folders first if you're not sure what a sync is about to do. - If the server's clock is off, set
remoteTimeOffsetInHours— otherwise timestamp-based sync can end up copying in the wrong direction. If timestamps are hopeless (checkouts, build steps, servers that don't keep them), switch tocompareMode"content". - Shared hosts often choke on too many simultaneous SFTP operations; dropping
concurrencyto 1–3 trades some speed for not getting rate-limited. - After touching
sftp.json, just runSFTP: Test Connection— cheaper than finding the typo mid-upload. - Profiles beat juggling several config files for dev/staging/prod, and don't forget the
… To All Profilescommands exist for the day a release needs to land everywhere at once.
Getting started
Reference
Guides
Help
Project