README
¶
Website | Documentation | Contributing | Changelog | Installation | Forum G+
Rclone is a command line program to sync files and directories to and from
- Amazon Drive
- Amazon S3 / Dreamhost / Ceph / Minio / Wasabi
- Backblaze B2
- Box
- Dropbox
- FTP
- Google Cloud Storage
- Google Drive
- HTTP
- Hubic
- Microsoft Azure Blob Storage
- Microsoft OneDrive
- Openstack Swift / Rackspace cloud files / Memset Memstore / OVH / Oracle Cloud Storage
- pCloud
- QingStor
- SFTP
- Webdav / Owncloud / Nextcloud
- Yandex Disk
- The local filesystem
Features
- MD5/SHA1 hashes checked at all times for file integrity
- Timestamps preserved on files
- Partial syncs supported on a whole file basis
- Copy mode to just copy new/changed files
- Sync (one way) mode to make a directory identical
- Check mode to check for file hash equality
- Can sync to and from network, eg two different cloud accounts
- Optional encryption (Crypt)
- Optional FUSE mount
See the home page for installation, usage, documentation, changelog and configuration walkthroughs.
License
This is free software under the terms of MIT the license (check the COPYING file included in this package).
Documentation
¶
Overview ¶
Sync files and directories to and from local and remote object stores
Nick Craig-Wood <nick@craig-wood.com>
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package amazonclouddrive provides an interface to the Amazon Cloud Drive object storage system.
|
Package amazonclouddrive provides an interface to the Amazon Cloud Drive object storage system. |
|
Package b2 provides an interface to the Backblaze B2 object storage system
|
Package b2 provides an interface to the Backblaze B2 object storage system |
|
Package box provides an interface to the Box object storage system.
|
Package box provides an interface to the Box object storage system. |
|
api
Package api has type definitions for box Converted from the API docs with help from https://mholt.github.io/json-to-go/
|
Package api has type definitions for box Converted from the API docs with help from https://mholt.github.io/json-to-go/ |
|
Package cmd implemnts the rclone command It is in a sub package so it's internals can be re-used elsewhere
|
Package cmd implemnts the rclone command It is in a sub package so it's internals can be re-used elsewhere |
|
all
Package all imports all the commands
|
Package all imports all the commands |
|
ncdu/scan
Package scan does concurrent scanning of an Fs building up a directory tree.
|
Package scan does concurrent scanning of an Fs building up a directory tree. |
|
Package crypt provides wrappers for Fs and Object which implement encryption
|
Package crypt provides wrappers for Fs and Object which implement encryption |
|
pkcs7
Package pkcs7 implements PKCS#7 padding This is a standard way of encoding variable length buffers into buffers which are a multiple of an underlying crypto block size.
|
Package pkcs7 implements PKCS#7 padding This is a standard way of encoding variable length buffers into buffers which are a multiple of an underlying crypto block size. |
|
Package dircache provides a simple cache for caching directory to path lookups
|
Package dircache provides a simple cache for caching directory to path lookups |
|
Package drive interfaces with the Google Drive object storage system
|
Package drive interfaces with the Google Drive object storage system |
|
Package dropbox provides an interface to Dropbox object storage
|
Package dropbox provides an interface to Dropbox object storage |
|
dbhash
Package dbhash implements the dropbox hash as described in https://www.dropbox.com/developers/reference/content-hash
|
Package dbhash implements the dropbox hash as described in https://www.dropbox.com/developers/reference/content-hash |
|
Package fs is a generic file system interface for rclone object storage systems
|
Package fs is a generic file system interface for rclone object storage systems |
|
Package fstest provides utilities for testing the Fs
|
Package fstest provides utilities for testing the Fs |
|
fstests
Package fstests provides generic tests for testing the Fs and Object interfaces Run go generate to write the tests for the remotes
|
Package fstests provides generic tests for testing the Fs and Object interfaces Run go generate to write the tests for the remotes |
|
Package ftp interfaces with FTP servers
|
Package ftp interfaces with FTP servers |
|
Package googlecloudstorage provides an interface to Google Cloud Storage
|
Package googlecloudstorage provides an interface to Google Cloud Storage |
|
Package hubic provides an interface to the Hubic object storage system.
|
Package hubic provides an interface to the Hubic object storage system. |
|
Package local provides a filesystem interface
|
Package local provides a filesystem interface |
|
Package onedrive provides an interface to the Microsoft OneDrive object storage system.
|
Package onedrive provides an interface to the Microsoft OneDrive object storage system. |
|
Package pacer makes pacing and retrying API calls easy
|
Package pacer makes pacing and retrying API calls easy |
|
Package pcloud provides an interface to the Pcloud object storage system.
|
Package pcloud provides an interface to the Pcloud object storage system. |
|
api
Package api has type definitions for pcloud Converted from the API docs with help from https://mholt.github.io/json-to-go/
|
Package api has type definitions for pcloud Converted from the API docs with help from https://mholt.github.io/json-to-go/ |
|
Package rest implements a simple REST wrapper All methods are safe for concurrent calling.
|
Package rest implements a simple REST wrapper All methods are safe for concurrent calling. |
|
Package s3 provides an interface to Amazon S3 oject storage
|
Package s3 provides an interface to Amazon S3 oject storage |
|
Package swift provides an interface to the Swift object storage system
|
Package swift provides an interface to the Swift object storage system |
|
Package vfs provides a virtual filing system layer over rclone's native objects.
|
Package vfs provides a virtual filing system layer over rclone's native objects. |
|
vfsflags
Package vfsflags implements command line flags to set up a vfs
|
Package vfsflags implements command line flags to set up a vfs |
|
Package webdav provides an interface to the Webdav object storage system.
|
Package webdav provides an interface to the Webdav object storage system. |
|
api
Package api has type definitions for webdav
|
Package api has type definitions for webdav |
|
Package yandex provides an interface to the Yandex Disk storage.
|
Package yandex provides an interface to the Yandex Disk storage. |
Click to show internal directories.
Click to hide internal directories.