# upload-site

> Upload your site via FTP, with incremental uploading based on directory hashes

Latest version **1.0.0** (published 2018-04-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install upload-site
pnpm add upload-site
yarn add upload-site
bun add upload-site
```

Provides the command `upload-site`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2018-04-12 |
| First published | 2018-04-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 9 |
| Dependencies | 9 |
| Unpacked size | 8.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | benstyles |
| Maintainers | benstyles |
| Keywords | upload, deploy, website, ftp |

## Links

- npm: https://www.npmjs.com/package/upload-site
- Repository: https://github.com/Leeds-eBooks/upload-site
- Homepage: https://github.com/Leeds-eBooks/upload-site#readme
- Issues: https://github.com/Leeds-eBooks/upload-site/issues
- npm.io page: https://npm.io/package/upload-site

## Dependencies (9)

- [esm](https://npm.io/package/esm.md) ^3.0.17
- [jsftp](https://npm.io/package/jsftp.md) ^2.1.2
- [maybes](https://npm.io/package/maybes.md) ^0.2.3
- [jsonfile](https://npm.io/package/jsonfile.md) ^4.0.0
- [pkg-conf](https://npm.io/package/pkg-conf.md) ^2.1.0
- [progress](https://npm.io/package/progress.md) ^2.0.0
- [hash-files](https://npm.io/package/hash-files.md) ^1.1.1
- [util-promisifyall](https://npm.io/package/util-promisifyall.md) ^1.0.3
- [log-color-optionaldate](https://npm.io/package/log-color-optionaldate.md) ^1.1.1

## Recent versions

- 1.0.0 (latest) — 2018-04-12
- 0.0.11 — 2018-04-11
- 0.0.10 — 2018-04-11
- 0.0.9 — 2018-04-11
- 0.0.8 — 2018-04-11
- 0.0.7 — 2018-04-11
- 0.0.6 — 2018-04-11
- 0.0.5 — 2018-04-11
- 0.0.4 — 2018-04-11
- 0.0.2 — 2018-04-11

## README

# upload-site

A simple script to upload your folder to a remote server, via `ftp`.

Supports incremental uploads via directory hashing – in other words, if you haven't changed any of the contents of a sub-folder, next time you run this script, it will **ignore** that sub-folder. Then, if you change any of the contents of that sub-folder, next time you run this script, it will **upload** that sub-folder.

```sh
yarn add --dev upload-site

yarn run upload-site
```

## Requirements

This package requires [Node.js](https://nodejs.org/) **v9** or greater.

## Configuration

### `package.json`

```json
{
  "upload-site": {
    "auth": {
      "host": "domain.com",
      "port": 21,
      "authKey": "my-ftppass-json-key"
    },
    "src": "dist",
    "dest": "/blog"
  }
}
```

### `.ftppass`

> **Note:** make sure to add `.ftppass` to your `.gitignore`!

```json
{
  "my-ftppass-json-key": {
    "username": "ben@domain.com",
    "password": "qwertyui"
  }
}
```

### CLI options

#### `--debug`

extra logging

#### `--dry`

perform all actions **except** `ftp put` – useful for testing ftp login, etc

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