# simple-ftp-deploy

> A node library that simplifies the usage of ftp-deploy package

Latest version **1.0.6** (published 2026-02-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-ftp-deploy
pnpm add simple-ftp-deploy
yarn add simple-ftp-deploy
bun add simple-ftp-deploy
```

Provides the command `simple-ftp-deploy`.

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2026-02-25 |
| First published | 2021-09-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Vinicius Kiss |
| Maintainers | vinik |
| Keywords | ftp, deploy |

## Links

- npm: https://www.npmjs.com/package/simple-ftp-deploy
- Repository: https://github.com/vkiss/simple-ftp-deploy
- Homepage: https://github.com/vkiss/simple-ftp-deploy#readme
- Issues: https://github.com/vkiss/simple-ftp-deploy/issues
- npm.io page: https://npm.io/package/simple-ftp-deploy

## Dependencies (3)

- [chalk](https://npm.io/package/chalk.md) ^5.6.2
- [ftp-deploy](https://npm.io/package/ftp-deploy.md) ^2.4.7
- [cosmiconfig](https://npm.io/package/cosmiconfig.md) ^9.0.0

## Recent versions

- 1.0.6 (latest) — 2026-02-25
- 1.0.6-beta.5 (beta) — 2026-02-25
- 1.0.6-beta.4 — 2026-02-25
- 1.0.6-beta.3 — 2026-02-25
- 1.0.6-beta.2 — 2026-02-25
- 1.0.6-beta.1 — 2026-02-25
- 1.0.6-beta.0 — 2026-02-25
- 1.0.5 — 2023-10-27
- 1.0.4 — 2022-07-06
- 1.0.3 — 2022-05-31
- 1.0.2 — 2022-04-21
- 1.0.1 — 2021-11-05
- 1.0.0 — 2021-09-30
- 0.0.1-beta.2 — 2021-09-30
- 0.0.1-beta.1 — 2021-09-30
- … 1 more at https://npm.io/package/simple-ftp-deploy/versions

## README

# simple-ftp-deploy
[![npm version](https://badge.fury.io/js/simple-ftp-deploy.svg)](https://badge.fury.io/js/simple-ftp-deploy)

A node library that simplifies the usage of [ftp-deploy](https://www.npmjs.com/package/ftp-deploy)

## Instalation

```sh
npm i simple-ftp-deploy --save-dev
```

## Repository configuration

### Create the auth file

```json
# .deploy/auth.json
{
  "host": "ftp.someserver.com",
  "user": "user",
  "password": "password",
  "port": 21
}
```

If you wish to place this file on another path, point the new auth config path into your package.json:

```json
# package.json
{
  "ftp": {
    "authFile": "./new-path/auth.json"
  }
}
```

> **Recommendation:** Do NOT commit the file containing your FTP credentials. Put it on .gitignore, or somewhere outside your project's repository

### Create the deploy config file

```json
# .deploy/config.json
{
  "localRoot": "/local-folder",
  "remoteRoot": "/public_html/remote-folder/",
  "include": ["*.php", "dist/*", ".*"],
  "exclude": ["dist/**/*.map", "node_modules/**", "node_modules/**/.*", ".git/**"],
  "deleteRemote": false,
  "forcePasv": true,
  "sftp": false
}
```

To see all config options, check [ftp-deploy](https://www.npmjs.com/package/ftp-deploy)

If you wish to place this file on another path, point the new auth config path into your package.json:

```json
# package.json
{
  "ftp": {
    "configFile": "./new-path/config.json"
  }
}
```

### Script Command

After creating all config files, include a new script on your package.json

```json
# package.json
{
  "scripts": {
    "deploy": "simple-ftp-deploy"
  }
}
```

---
_Source: https://npm.io/package/simple-ftp-deploy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._