Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/serkanyersen/sync
syncs your local folder with remote folder using scp
https://github.com/serkanyersen/sync
cli ftp nodejs remote remote-dev-server rsync scp sftp ssh sync
Last synced: about 5 hours ago
JSON representation
syncs your local folder with remote folder using scp
- Host: GitHub
- URL: https://github.com/serkanyersen/sync
- Owner: serkanyersen
- License: mit
- Created: 2013-07-16T01:22:53.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2022-08-30T13:19:54.000Z (about 2 years ago)
- Last Synced: 2024-11-06T20:23:33.043Z (7 days ago)
- Topics: cli, ftp, nodejs, remote, remote-dev-server, rsync, scp, sftp, ssh, sync
- Language: TypeScript
- Size: 176 KB
- Stars: 313
- Watchers: 16
- Forks: 35
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://snyk.io/test/github/serkanyersen/sync)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fserkanyersen%2Fsync?ref=badge_shield)
Syncjs - Upload changed local files to remote server
----------------------------------------------------
Syncjs is an easy to use command line tool for uploading your local changes to a remote server.
It's useful in situations where your application needs to be on a remote server to run (dev machines, pubdev environments, etc.) but you still want to use your local environment for development. You can simply map you local copy of the project to the remote version and syncjs will do the rest.
This example shows usage with Visual Studio Code but since it's an external script, you can use it with any editor you want.
Features
--------
- Easy to setup
- Fast and reliable
- Runs independently from your toolchain so you can use it with anything
- Runs on windows, osx and linux
- detects and handles changes on folders
- can run multiple instances at the same time
Installation
------------
Syncjs is easy to install, just execute the following
```
npm install -g syncjs
```
After this you'll have `syncjs` binary available to you.
Configuration
-------------
Syncjs comes with an init script and sets itself up for you. All you need to do is to `cd` into your projects directory and run `syncjs init` it will ask few simple questions and create the config file called `sync-config.json` make sure you include this file in your `.gitignore` because this file might contain passwords or secrets depending on your preferences.
```
cd /my/project/folder
syncjs init
```
### Questions on config
- **Username**: your username that you use to connect to remote machine
- **Auth method**:
- **Password in config**: This the least secure version of auth. It will keep your password in the config file **as plain text** do not use this please
- **Ask during connect**: This option will ask your password again every time you start `syncjs` your password will not be stored anywhere.
- **Private Key**: Most secure option, just provide the path for your key file and syncjs will do the rest
- **Hostname or IP of the server**: Tell syncjs where to connect
- **Port to connect**: defaults to `22` this usually is what you want
- **Local path**: syncjs will automatically detect this as the root of your project, but if you only want to sync one specific folder, **provide it here as full path**
- **Remote path**: This is where copy of your local folder lives in the remote server. Make sure you type full path here as well.
License
-------
MIT
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fserkanyersen%2Fsync?ref=badge_large)