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 using npm install @samkirkland/ftp-deploy --only=dev

• Run via command line ftp-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 your package.json file under scripts section. See example below.

• You can run the script using the following command npm run deploy (run this in the folder that has the package.json file)

Example of package.json:

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

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

Example of myCustomDeployment.js:

import { deploy, excludeDefaults } from "@samkirkland/ftp-deploy";

async function deployMyCode() {
  console.log("🚚 Deploy started");
  await deploy({
    server: "ftp.samkirkland.com",
    username: "username@samkirkland.com",
    password: `CrazyUniquePassword&%123`, // note: I'm using backticks here ` so I don't have to escape quotes
    exclude: [...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 run ftp-deploy without any options.