remote-folder-sync v0.0.6
Remote Folder Sync
remote-folder-sync is a npm command line tool to download and upload directories to cloud services (ie: Dropbox)
Current state: proof of concept (PoC)
remote-folder-sync up to now supports only Dropbox. Its aim is to allow synchronization between Emacs and Orgzly. As a proof of concept, there are still several task to do. But there is already a working flow described in this post (TODO: Link post)
Getting started
Installation
Remote Folder Sync requires Node.js v4+ to run.
Install it as a global package
$ npm -g install remote-folder-syncUse
Initialize the folder
$ cd folder-to-sync
$ remote-folder-sync initDownload the latest version of the files
$ cd folder-to-sync
$ remote-folder-sync pullUpload your changes
$ cd folder-to-sync
$ remote-folder-sync pushTips and tricks!
Custom alias
Setup an alias for remote-folder-sync
$ alias folder remote-folder-syncThat way, instead of:
$ cd folder-to-sync
$ remote-folder-sync pull
$ remote-folder-sync pushJust do:
$ cd folder-to-sync
$ folder pull
$ folder pushTO DOs
Remote Folder Sync is in state PoC. Further improvements can be done
| Priority | TODO |
|---|---|
| 1 | Check if the file already exist and provides a diff |
| 1 | Only uploads changed files |
| 2 | Use auth instead of accessToken for Dropbox |
| 2 | Check if the folder was initialized |
| 3 | Test connection |
| 3 | Show current files in the remote directory |
Development
Want to contribute? Great!
remote-folder-sync uses Nodesjs + Typescript.
Open your favorite Terminal and run these commands.
Setup the project:
$ git clone https://github.com/johmsalas/remote-folder-sync.git
$ cd remote-folder-sync
$ yarn install
$ npm linkTo test the project, run remote-folder-sync-dev instead of remote-folder-sync, like this:
$ remote-folder-sync-dev init
$ remote-folder-sync-dev pull
$ remote-folder-sync-dev pushLicense
MIT