README
¶
Ugoku
Overview
A SFTP client written in Golang. The objective is to allow automated machine to machine file transfer via SFTP.
Motivation
This is a project which I try to apply what I learned in Golang. That said, I do try to make it a useful app for the community. Feedbacks are welcomed, although I can't guarantee a timely response :)
Features
- SFTP Downloader (SFTP server to local folder, files are removed after download)
- SFTP Uploader (local folder to SFTP server, files are removed after upload)
- Sync to Local (mirror files from SFTP server, files are not removed)
- Sync to Server (mirror files to SFTP server, files are not removed)
- Streamer (SFTP Server to Server transfer via Ugoku as bridge, without writting to local storage)
- build in logger
Usage
The ugoku binary can be ran as both a command line tool and service.
Service mode:
ugoku serve
Command line mode:
ugoku [ upload | download | sync | stream ]
In service mode, ugoku will not quit and keep scan for files for upload/download.
In other mode (upload,downlod,sync,stream), it will run/scan once, finish the operation (upload/download etc) than exit. This could be good for scheduled cronjob.
Building
Dependencies
- Golang runtime
- Task (https://github.com/go-task/task)
Just run this from command line in ugoku repo folder
task build
To build for linux/windows only
task build_linux
or
task build_windows
Todo
- Archiving support for downloader/uploader/streamer
Why the name Ugoku
Ugoku in Japanese means move. This app moves files around, hence the name. Bonus point it has "go" in the name.
License
Ugoku is available under the MIT license.See LICENSE for the full license text.
Directories