Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zemd/webdav-watch

🐙Simple cli tool for synchronizing folder with remote webdav server
https://github.com/zemd/webdav-watch

cli webdav webdav-watch

Last synced: 3 days ago
JSON representation

🐙Simple cli tool for synchronizing folder with remote webdav server

Awesome Lists containing this project

README

        

# webdav-watch

> Simple cli tool for synchronizing folder with remote webdav server

[![npm version](https://badge.fury.io/js/webdav-watch.svg)](https://www.npmjs.com/package/webdav-watch)
[![Code Climate](https://codeclimate.com/github/zemd/webdav-watch/badges/gpa.svg)](https://codeclimate.com/github/zemd/webdav-watch)
[![dependencies:?](https://img.shields.io/david/zemd/webdav-watch.svg)](https://david-dm.org/zemd/webdav-watch)
[![devDependencies:?](https://img.shields.io/david/dev/zemd/webdav-watch.svg?style=flat)](https://david-dm.org/zemd/webdav-watch)

## Installation

```bash
npm install webdav-watch -g
```

## Usage

```bash
webdav-watch watch [folder] -p '!**/.idea/**' -p '!**/.git/**' -r https://webdav-server.com/remote/root/folder -u username
```

On first call you will be requested for entering password, which will be stored in your system's keychain.

If neither `folder` or `patters`(`-p`) have been provided, current working dir is being used. `folder` can be useful when
you need to watch directory other than `cwd` and is used by `webdav-watch` to build correct remote path for uploading file.

### Configuration

You can pass configuration file, as `-c` option.

```bash
webdav-watch watch [folder_path] -c path/to/config.json
```

which has to have next structure:

```json
{
"remote": "https://webdav-server.com/remote/root/folder",
"username": "username",
"folder": "~/project",
"patterns": [
"!**/.idea/**",
"!**/.git/**",
"ANY_VALID_GLOB_HERE"
]
}
```

### Advanced configuration

You can to use `uri` for your remote config option, that includes valid credentials, for instance, `https://user:[email protected]`.

## License

webdav-watch is released under the MIT license.

## Donate

[![](https://img.shields.io/badge/patreon-donate-yellow.svg)](https://www.patreon.com/red_rabbit)
[![](https://img.shields.io/badge/flattr-donate-yellow.svg)](https://flattr.com/profile/red_rabbit)