refactor: finish moving ssh-* scripts to own installers
[webi-installers/.git] / rclone / README.md
1 ---
2 title: rclone
3 homepage: https://github.com/rclone/rclone
4 tagline: |
5   rclone: "rsync for cloud storage".
6 ---
7
8 To update or switch versions, run `webi rclone@stable` (or `@v1.54`, `@beta`,
9 etc).
10
11 ## Cheat Sheet
12
13 > rclone is like rsync, but optimized for cloud storage and SSDs. rclone is also
14 > faster than rsync for many use cases.
15
16 `rclone` is compatible with a wide range of cloud storage providers including:
17
18 - Google Drive
19 - S3
20   - (AWS, Minio, Digital Ocean, etc)
21 - Dropbox
22 - Backblaze B2
23 - One Drive
24 - Swift
25 - Hubic
26 - Wasabi
27 - Google Cloud Storage
28 - Yandex Files
29
30 ### How to copy local files, like rsync
31
32 `rclone`s cloud-first, SSD-first optimizations can cause performance issues when
33 copying between HDDs. For performance more similar to `cp` (better than `rsync`)
34 you can use the following options:
35
36 `--tranfers=1` will only copy one file at a time, preventing thrashing and
37 fragmentation.
38
39 `--check-first` will catalog files before copying.
40
41 `--order-by name` will copy files one directory at a time.
42
43 Example:
44
45 ```bash
46 rclone sync -vP --transfers=1 --order-by name --check-first ~/ /Volumes/Backup/home
47 ```
48
49 Example, excluding common temporary directories:
50
51 ```bash
52 rclone sync -vP --transfers=1 --order-by name --check-first \
53   --exclude 'node_modules/**' --exclude '.Spotlight-*/**' --exclude '.cache*/**' \
54   ~/ /Volumes/Backup/home
55 ```