# sync-to-remote

> Monitor files change and synchronize to the remote repo

Latest version **0.1.0** (published 2018-01-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install sync-to-remote
pnpm add sync-to-remote
yarn add sync-to-remote
bun add sync-to-remote
```

Provides the command `sync-to-remote`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-01-11 |
| First published | 2018-01-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | zce |
| Maintainers | zce |
| Keywords | cli, zce |

## Links

- npm: https://www.npmjs.com/package/sync-to-remote
- Repository: https://github.com/zce/sync-to-remote
- Homepage: https://github.com/zce/sync-to-remote#readme
- Issues: https://github.com/zce/sync-to-remote/issues
- npm.io page: https://npm.io/package/sync-to-remote

## Dependencies (4)

- [gift](https://npm.io/package/gift.md) ^0.10.1
- [chokidar](https://npm.io/package/chokidar.md) ^2.0.0
- [gh-pages](https://npm.io/package/gh-pages.md) ^1.1.0
- [commander](https://npm.io/package/commander.md) ^2.11.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2018-01-11

## README

# sync-to-remote

[![NPM Downloads][downloads-image]][downloads-url]
[![NPM Version][version-image]][version-url]
[![License][license-image]][license-url]
[![Dependency Status][dependency-image]][dependency-url]
[![devDependency Status][devdependency-image]][devdependency-url]
[![Code Style][style-image]][style-url]

> Monitor files change and synchronize to the remote repo

## Installation

```sh
$ yarn add sync-to-remote

# or npm
$ npm install sync-to-remote
```

## Usage

```js
const syncToRemote = require('sync-to-remote')
const result = syncToRemote('zce')
console.log(result)
// => 'zce@zce.me'
```

## API

### syncToRemote(name[, options])

#### name

- Type: `string`
- Details: name string

#### options

##### host

- Type: `string`
- Details: host string
- Default: `'zce.me'`

## CLI Usage

```shell
$ yarn global add sync-to-remote

# or npm
$ npm install sync-to-remote -g
```

```shell
$ sync-to-remote --help

  Usage: creative <input>

  Options:

    -V, --version  output the version number
    -H, --host     Email host
    -h, --help     output usage information
```

## Contributing

1. **Fork** it on GitHub!
2. **Clone** the fork to your own machine.
3. **Checkout** your feature branch: `git checkout -b my-awesome-feature`
4. **Commit** your changes to your own branch: `git commit -am 'Add some feature'`
5. **Push** your work back up to your fork: `git push -u origin my-awesome-feature`
6. Submit a **Pull Request** so that we can review your changes.

> **NOTE**: Be sure to merge the latest from "upstream" before making a pull request!

## License

[MIT](LICENSE) &copy; zce <w@zce.me> (https://zce.me/)



[downloads-image]: https://img.shields.io/npm/dm/sync-to-remote.svg
[downloads-url]: https://npmjs.org/package/sync-to-remote
[version-image]: https://img.shields.io/npm/v/sync-to-remote.svg
[version-url]: https://npmjs.org/package/sync-to-remote
[license-image]: https://img.shields.io/npm/l/sync-to-remote.svg
[license-url]: https://github.com/zce/sync-to-remote/blob/master/LICENSE
[dependency-image]: https://img.shields.io/david/zce/sync-to-remote.svg
[dependency-url]: https://david-dm.org/zce/sync-to-remote
[devdependency-image]: https://img.shields.io/david/dev/zce/sync-to-remote.svg
[devdependency-url]: https://david-dm.org/zce/sync-to-remote?type=dev
[style-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[style-url]: http://standardjs.com

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