# remotely-cli

> Watch and automatcally sync directories remotely

Latest version **1.0.9** (published 2017-10-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install remotely-cli
pnpm add remotely-cli
yarn add remotely-cli
bun add remotely-cli
```

Provides the command `remotely`.

## 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.9 |
| Published | 2017-10-06 |
| First published | 2017-10-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | gcledingham, charlesbodman |

## Links

- npm: https://www.npmjs.com/package/remotely-cli
- Repository: https://github.com/charlesbodman/remotely
- Homepage: https://github.com/charlesbodman/remotely#readme
- Issues: https://github.com/charlesbodman/remotely/issues
- npm.io page: https://npm.io/package/remotely-cli

## Dependencies (8)

- [chalk](https://npm.io/package/chalk.md) ^2.1.0
- [find-up](https://npm.io/package/find-up.md) ^2.1.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.7.8
- [chokidar](https://npm.io/package/chokidar.md) ^1.7.0
- [debounce](https://npm.io/package/debounce.md) ^1.0.2
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [comment-json](https://npm.io/package/comment-json.md) ^1.1.3
- [node-notifier](https://npm.io/package/node-notifier.md) ^5.1.2

## Recent versions

- 1.0.9 (latest) — 2017-10-06
- 1.0.8 — 2017-10-06
- 1.0.7 — 2017-10-06
- 1.0.6 — 2017-10-06
- 1.0.5 — 2017-10-05
- 1.0.4 — 2017-10-03
- 1.0.3 — 2017-10-03

## README

# <img src="https://raw.githubusercontent.com/charlesbodman/remotely/master/icon.png" width="233"/>

## Rsyncing simplified, push, pull, watch.

## Table of Contents

- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Config](#config)
- [Maintainers](#maintainers)
- [Contribute](#contribute)
- [License](#license)

## Prerequisites
- rsync

## Install
```
npm install -g remotely-cli
```

## Usage

**Create remotely config (`.remotely.json`)**
```
$ remotely init
```
Run this in any parent directory from where you are going to be running `remotely`.

Remotely will climb up and use the first config file it finds
[Read about config here](#config)

Make sure you edit your config (`.remotely.json`) file after doing this.

---

**Watch local directory for changes and rsync push on change**
```
$ remotely watch
```
---

**Rsync pull down remote**
```
$ remotely pull
```
---

**Rsync push to remote**
```
$ remotely push
```
---

## Config
Remotely will look for the config file `.remotely.json` in any directory above where you call `remotely [command]`.
This means that the config can belong anywhere, as long as remotely can find it by traversing upwards

| Config        | Desc         |                |
| ------------- |:-------------:|:-------------:|
| local         | local path to sync dir | required |
| remote      | remote host and path | required |
| rsync_flags | flags to customize rsync  | optional |
| dry_run | perform dry run | optional |
| exclude | files or directories to exclude | optional |
| notify | notify when complete | optional |

**Example config**

This could live in `/Users/charliebodman/documents/example/.remotely.json`
You can create remotely config by calling `remotely init`
```javascript
{
    "local":"/Users/charliebodman/documents/example/project",
    "remote":"charlie@example.com:~/example/project"
}
```

## Maintainers

[@charlesbodman](https://github.com/@charlesbodman)

## Contribute

PRs accepted.

## License

MIT © 2017 Charles Bodman

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