Skip to content

Commit 6b3b354

Browse files
Added rclone page (#2199)
Added cheatsheet for Rclone --------- Co-authored-by: Rico Sta. Cruz <rstacruz@users.noreply.github.com>
1 parent f4cc3b1 commit 6b3b354

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

rclone.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: rclone
3+
category: CLI
4+
---
5+
6+
### Basic configuration
7+
8+
```bash
9+
rclone config # Start the interactive configuration wizard to add new remotes
10+
rclone config show # Display the current configuration
11+
rclone listremotes # List the names of all configured remotes
12+
```
13+
14+
### Listing files & directories
15+
16+
```bash
17+
rclone ls <remote>:<path> # List files and file sizes
18+
rclone lsl <remote>:<path> # List files, sizes, and modification times
19+
rclone lsd <remote>:<path> # List directories only
20+
rclone tree <remote>:<path> # List contents in a tree-like structure
21+
```
22+
23+
### Copying & syncing
24+
25+
#### Copy
26+
27+
```bash
28+
rclone copy <source> <dest> # Copy new/changed files
29+
rclone copy <source> <dest> --dry-run # Test the copy operation without making changes
30+
```
31+
32+
#### Sync
33+
34+
```bash
35+
rclone sync <source> <dest> # Sync source to destination
36+
rclone sync <source> <dest> --dry-run # Test the sync operation (recommended before actual sync)
37+
```
38+
39+
### Deleting & moving
40+
41+
```bash
42+
rclone move <source> <dest> # Move files (copy and then delete the source)
43+
rclone delete <remote>:<path> # Delete the files in the path
44+
rclone purge <remote>:<path> # Delete the path and all of its contents (Irrecoverable!)
45+
rclone rmdir <remote>:<path> # Remove an empty directory
46+
```
47+
48+
### File manipulation
49+
50+
```bash
51+
rclone mkdir <remote>:<path> # Create a new directory
52+
rclone touch <remote>:<path>/file.txt # Create a new file with the current time
53+
rclone cat <remote>:<path>/file.txt # Output the file content to standard output
54+
rclone check <source> <dest> # Check if the files in source and dest are identical
55+
```
56+
57+
### Important flags (general)
58+
59+
```bash
60+
--dry-run # Show what would be transferred without doing it
61+
-P or --progress # Show progress during transfer
62+
--transfers=N # Set number of file transfers to run in parallel (default 4)
63+
--checkers=N # Set number of checkers to run in parallel (default 8)
64+
--max-age <time> # Don't transfer files older than <time>
65+
--min-age <time> # Don't transfer files newer than <time>
66+
--include <filter> # Include files matching this pattern
67+
--exclude <filter> # Exclude files matching this pattern
68+
--fast-list # Use recursive listing to speed up checks (may use more memory)
69+
--multi-thread-cutoff <size> # Use multiple threads for files bigger than <size>
70+
--multi-thread-streams <N> # Number of streams to use for multi-thread transfers
71+
```

0 commit comments

Comments
 (0)