summaryrefslogtreecommitdiff
path: root/cheatsheets/rclone_cheat_sheet.md
blob: 4637fcd7d9da0239fc19266c54a2fec13befeacc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
# 📘 Rclone Command Cheat Sheet

## ⚙️ Configuration

### Launch Configuration Wizard
```bash
rclone config
```

### Show Current Config
```bash
rclone config show
```

### List Remotes
```bash
rclone listremotes
```

## 📁 Basic File Operations

### Copy Files
```bash
rclone copy source:path dest:path
```

### Sync Files
```bash
rclone sync source:path dest:path
```

### Move Files
```bash
rclone move source:path dest:path
```

### Delete Files or Dirs
```bash
rclone delete remote:path
rclone purge remote:path   # Delete entire path
```

### Check Differences
```bash
rclone check source:path dest:path
```

## 🔍 Listing and Info

### List Directory
```bash
rclone ls remote:path
rclone lsd remote:path     # List only directories
rclone lsl remote:path     # Long list with size and modification time
```

### Tree View
```bash
rclone tree remote:path
```

### File Size and Count
```bash
rclone size remote:path
```

## 📦 Mounting

### Mount Remote (Linux/macOS)
```bash
rclone mount remote:path /mnt/mountpoint
```

### Mount with Aggressive Caching (Windows)
```bash
rclone mount remote:path X: \
  --vfs-cache-mode full \
  --cache-dir C:\path\to\cache \
  --vfs-cache-max-size 100G \
  --vfs-read-chunk-size 512M \
  --vfs-read-ahead 1G
```

## 🔁 Sync with Filtering

### Include / Exclude Files
```bash
rclone sync source:path dest:path --exclude "*.tmp"
rclone sync source:path dest:path --include "*.jpg"
```

## 📄 Logging and Dry Runs

### Verbose and Dry Run
```bash
rclone sync source:path dest:path -v --dry-run
```

### Log to File
```bash
rclone sync source:path dest:path --log-file=rclone.log -v
```

## 📡 Remote Control (RC)

### Start RC Server
```bash
rclone rcd --rc-web-gui
```

### Use RC Command
```bash
rclone rc core/stats
rclone rc vfs/stats
```

## 🛠️ Miscellaneous

### Serve Over HTTP/WebDAV/SFTP
```bash
rclone serve http remote:path
rclone serve webdav remote:path
rclone serve sftp remote:path
```

### Crypt Operations
```bash
rclone config create secure crypt remote:path
```

---

> ✅ **Tip**: Always use `--dry-run` when testing `sync`, `move`, or `delete` to prevent accidental data loss.