Repository files navigation

Syncs a local folder with a remote folder over ftp.

After the initial sync only differences are synced, making deployments super fast!

• Install the npm package usingnpm install @samkirkland/ftp-deploy --only=dev

• Run via command lineftp-deploy --server ftp.samkirkland.com --username test@samkirkland.com --password \"CrazyUniquePassword&%123\"

• Or you can add a script to make deployments easier

• Add a new key to yourpackage.json file underscripts section. See example below.

• You can run the script using the following commandnpm run deploy (run this in the folder that has thepackage.json file)

Example ofpackage.json:

{"scripts": {"deploy":"ftp-deploy --server ftp.samkirkland.com --username test@samkirkland.com --password\"CrazyUniquePassword&%123\"",  },}

• Install the npm package usingnpm install @samkirkland/ftp-deploy --only=dev
• Import the code and use it in your code

Example ofmyCustomDeployment.js:

import{deploy,excludeDefaults}from"@samkirkland/ftp-deploy";asyncfunctiondeployMyCode(){console.log("🚚 Deploy started");awaitdeploy({server:"ftp.samkirkland.com",username:"username@samkirkland.com",password:`CrazyUniquePassword&%123`,// note: I'm using backticks here ` so I don't have to escape quotesexclude:[...excludeDefaults,"dontDeployThisFolder/**"]// excludeDefaults will exclude .git files and node_modules});console.log("🚀 Deploy done!");}deployMyCode();

If you use github as source control you can automatically re-deploy your site on every git commit.Read more

To list all commands with examples simply runftp-deploy without any options.