README
¶
Website | Documentation | Contributing | Changelog | Installation | Forum G+
Rclone is a command line program to sync files and directories to and from
- Amazon Drive (See note)
- Amazon S3 / Dreamhost / Ceph / Minio / Wasabi
- Backblaze B2
- Box
- Dropbox
- FTP
- Google Cloud Storage
- Google Drive
- HTTP
- Hubic
- Jottacloud
- Mega
- Microsoft Azure Blob Storage
- Microsoft OneDrive
- OpenDrive
- 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 |
|---|---|
|
backend
|
|
|
amazonclouddrive
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. |
|
b2
Package b2 provides an interface to the Backblaze B2 object storage system
|
Package b2 provides an interface to the Backblaze B2 object storage system |
|
box
Package box provides an interface to the Box object storage system.
|
Package box provides an interface to the Box object storage system. |
|
box/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/ |
|
crypt
Package crypt provides wrappers for Fs and Object which implement encryption
|
Package crypt provides wrappers for Fs and Object which implement encryption |
|
crypt/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. |
|
drive
Package drive interfaces with the Google Drive object storage system
|
Package drive interfaces with the Google Drive object storage system |
|
dropbox
Package dropbox provides an interface to Dropbox object storage
|
Package dropbox provides an interface to Dropbox object storage |
|
dropbox/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 |
|
ftp
Package ftp interfaces with FTP servers
|
Package ftp interfaces with FTP servers |
|
googlecloudstorage
Package googlecloudstorage provides an interface to Google Cloud Storage
|
Package googlecloudstorage provides an interface to Google Cloud Storage |
|
http
Package http provides a filesystem interface using golang.org/net/http It treats HTML pages served from the endpoint as directory listings, and includes any links found as files.
|
Package http provides a filesystem interface using golang.org/net/http It treats HTML pages served from the endpoint as directory listings, and includes any links found as files. |
|
hubic
Package hubic provides an interface to the Hubic object storage system.
|
Package hubic provides an interface to the Hubic object storage system. |
|
local
Package local provides a filesystem interface
|
Package local provides a filesystem interface |
|
mega
Package mega provides an interface to the Mega object storage system.
|
Package mega provides an interface to the Mega object storage system. |
|
onedrive
Package onedrive provides an interface to the Microsoft OneDrive object storage system.
|
Package onedrive provides an interface to the Microsoft OneDrive object storage system. |
|
onedrive/quickxorhash
Package quickxorhash provides the quickXorHash algorithm which is a quick, simple non-cryptographic hash algorithm that works by XORing the bytes in a circular-shifting fashion.
|
Package quickxorhash provides the quickXorHash algorithm which is a quick, simple non-cryptographic hash algorithm that works by XORing the bytes in a circular-shifting fashion. |
|
pcloud
Package pcloud provides an interface to the Pcloud object storage system.
|
Package pcloud provides an interface to the Pcloud object storage system. |
|
pcloud/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/ |
|
s3
Package s3 provides an interface to Amazon S3 oject storage
|
Package s3 provides an interface to Amazon S3 oject storage |
|
swift
Package swift provides an interface to the Swift object storage system
|
Package swift provides an interface to the Swift object storage system |
|
webdav
Package webdav provides an interface to the Webdav object storage system.
|
Package webdav provides an interface to the Webdav object storage system. |
|
webdav/api
Package api has type definitions for webdav
|
Package api has type definitions for webdav |
|
webdav/odrvcookie
Package odrvcookie can fetch authentication cookies for a sharepoint webdav endpoint
|
Package odrvcookie can fetch authentication cookies for a sharepoint webdav endpoint |
|
yandex
Package yandex provides an interface to the Yandex Disk storage.
|
Package yandex provides an interface to the Yandex Disk storage. |
|
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. |
|
serve/httplib
Package httplib provides common functionality for http servers
|
Package httplib provides common functionality for http servers |
|
serve/restic
Package restic serves a remote suitable for use with restic
|
Package restic serves a remote suitable for use with restic |
|
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 |
|
accounting
Package accounting providers an accounting and limiting reader
|
Package accounting providers an accounting and limiting reader |
|
asyncreader
Package asyncreader provides an asynchronous reader which reads independently of write
|
Package asyncreader provides an asynchronous reader which reads independently of write |
|
config
Package config reads, writes and edits the config file and deals with command line flags
|
Package config reads, writes and edits the config file and deals with command line flags |
|
config/configflags
Package configflags defines the flags used by rclone.
|
Package configflags defines the flags used by rclone. |
|
config/configmap
Package configmap provides an abstraction for reading and writing config
|
Package configmap provides an abstraction for reading and writing config |
|
config/configstruct
Package configstruct parses unstructured maps into structures
|
Package configstruct parses unstructured maps into structures |
|
config/flags
Package flags contains enahnced versions of spf13/pflag flag routines which will read from the environment also.
|
Package flags contains enahnced versions of spf13/pflag flag routines which will read from the environment also. |
|
config/obscure
Package obscure contains the Obscure and Reveal commands
|
Package obscure contains the Obscure and Reveal commands |
|
filter
Package filter controls the filtering of files
|
Package filter controls the filtering of files |
|
filter/filterflags
Package filterflags implements command line flags to set up a filter
|
Package filterflags implements command line flags to set up a filter |
|
fserrors
Package fserrors provides errors and error handling
|
Package fserrors provides errors and error handling |
|
fshttp
Package fshttp contains the common http parts of the config, Transport and Client
|
Package fshttp contains the common http parts of the config, Transport and Client |
|
fspath
Package fspath contains routines for fspath manipulation
|
Package fspath contains routines for fspath manipulation |
|
list
Package list contains list functions
|
Package list contains list functions |
|
log
Package log provides logging for rclone
|
Package log provides logging for rclone |
|
march
Package march traverses two directories in lock step
|
Package march traverses two directories in lock step |
|
object
Package object defines some useful Objects
|
Package object defines some useful Objects |
|
operations
Package operations does generic operations on filesystems and objects
|
Package operations does generic operations on filesystems and objects |
|
rc
Package rc implements a remote control server and registry for rclone To register your internal calls, call rc.Add(path, function).
|
Package rc implements a remote control server and registry for rclone To register your internal calls, call rc.Add(path, function). |
|
rc/rcflags
Package rcflags implements command line flags to set up the remote control
|
Package rcflags implements command line flags to set up the remote control |
|
sync
Package sync is the implementation of sync/copy/move
|
Package sync is the implementation of sync/copy/move |
|
walk
Package walk walks directories
|
Package walk walks directories |
|
Package fstest provides utilities for testing the Fs
|
Package fstest provides utilities for testing the Fs |
|
fstests
Package fstests provides generic integration tests for the Fs and Object interfaces
|
Package fstests provides generic integration tests for the Fs and Object interfaces |
|
mockdir
Package mockdir makes a mock fs.Directory object
|
Package mockdir makes a mock fs.Directory object |
|
mockobject
Package mockobject provides a mock object which can be created from a string
|
Package mockobject provides a mock object which can be created from a string |
|
test_all
Run tests for all the remotes.
|
Run tests for all the remotes. |
|
lib
|
|
|
atexit
Package atexit provides handling for functions you want called when the program exits unexpectedly due to a signal.
|
Package atexit provides handling for functions you want called when the program exits unexpectedly due to a signal. |
|
dircache
Package dircache provides a simple cache for caching directory to path lookups
|
Package dircache provides a simple cache for caching directory to path lookups |
|
israce
Package israce reports if the Go race detector is enabled.
|
Package israce reports if the Go race detector is enabled. |
|
pacer
Package pacer makes pacing and retrying API calls easy
|
Package pacer makes pacing and retrying API calls easy |
|
rest
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 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 |
Click to show internal directories.
Click to hide internal directories.