forked from rclone/rclone
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMANUAL.html
12227 lines (12202 loc) · 621 KB
/
MANUAL.html
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta name="generator" content="pandoc" />
<meta name="author" content="Nick Craig-Wood" />
<title>rclone(1) User Manual</title>
<style type="text/css">code{white-space: pre;}</style>
</head>
<body>
<div id="header">
<h1 class="title">rclone(1) User Manual</h1>
<h2 class="author">Nick Craig-Wood</h2>
<h3 class="date">Oct 15, 2018</h3>
</div>
<h1 id="rclone">Rclone</h1>
<p><a href="https://rclone.org/"><img src="https://rclone.org/img/rclone-120x120.png" alt="Logo" /></a></p>
<p>Rclone is a command line program to sync files and directories to and from:</p>
<ul>
<li>Amazon Drive (<a href="/amazonclouddrive/#status">See note</a>)</li>
<li>Amazon S3</li>
<li>Backblaze B2</li>
<li>Box</li>
<li>Ceph</li>
<li>DigitalOcean Spaces</li>
<li>Dreamhost</li>
<li>Dropbox</li>
<li>FTP</li>
<li>Google Cloud Storage</li>
<li>Google Drive</li>
<li>HTTP</li>
<li>Hubic</li>
<li>Jottacloud</li>
<li>IBM COS S3</li>
<li>Memset Memstore</li>
<li>Mega</li>
<li>Microsoft Azure Blob Storage</li>
<li>Microsoft OneDrive</li>
<li>Minio</li>
<li>Nextcloud</li>
<li>OVH</li>
<li>OpenDrive</li>
<li>Openstack Swift</li>
<li>Oracle Cloud Storage</li>
<li>ownCloud</li>
<li>pCloud</li>
<li>put.io</li>
<li>QingStor</li>
<li>Rackspace Cloud Files</li>
<li>SFTP</li>
<li>Wasabi</li>
<li>WebDAV</li>
<li>Yandex Disk</li>
<li>The local filesystem</li>
</ul>
<p>Features</p>
<ul>
<li>MD5/SHA1 hashes checked at all times for file integrity</li>
<li>Timestamps preserved on files</li>
<li>Partial syncs supported on a whole file basis</li>
<li><a href="https://rclone.org/commands/rclone_copy/">Copy</a> mode to just copy new/changed files</li>
<li><a href="https://rclone.org/commands/rclone_sync/">Sync</a> (one way) mode to make a directory identical</li>
<li><a href="https://rclone.org/commands/rclone_check/">Check</a> mode to check for file hash equality</li>
<li>Can sync to and from network, eg two different cloud accounts</li>
<li>(<a href="https://rclone.org/crypt/">Encryption</a>) backend</li>
<li>(<a href="https://rclone.org/cache/">Cache</a>) backend</li>
<li>(<a href="https://rclone.org/union/">Union</a>) backend</li>
<li>Optional FUSE mount (<a href="https://rclone.org/commands/rclone_mount/">rclone mount</a>)</li>
</ul>
<p>Links</p>
<ul>
<li><a href="https://rclone.org/">Home page</a></li>
<li><a href="https://github.com/ncw/rclone">GitHub project page for source and bug tracker</a></li>
<li><a href="https://forum.rclone.org">Rclone Forum</a></li>
<li><a href="https://google.com/+RcloneOrg" rel="publisher">Google+ page</a></li>
<li><a href="https://rclone.org/downloads/">Downloads</a></li>
</ul>
<h1 id="install">Install</h1>
<p>Rclone is a Go program and comes as a single binary file.</p>
<h2 id="quickstart">Quickstart</h2>
<ul>
<li><a href="https://rclone.org/downloads/">Download</a> the relevant binary.</li>
<li>Extract the <code>rclone</code> or <code>rclone.exe</code> binary from the archive</li>
<li>Run <code>rclone config</code> to setup. See <a href="https://rclone.org/docs/">rclone config docs</a> for more details.</li>
</ul>
<p>See below for some expanded Linux / macOS instructions.</p>
<p>See the <a href="https://rclone.org/docs/">Usage section</a> of the docs for how to use rclone, or run <code>rclone -h</code>.</p>
<h2 id="script-installation">Script installation</h2>
<p>To install rclone on Linux/macOS/BSD systems, run:</p>
<pre><code>curl https://rclone.org/install.sh | sudo bash</code></pre>
<p>For beta installation, run:</p>
<pre><code>curl https://rclone.org/install.sh | sudo bash -s beta</code></pre>
<p>Note that this script checks the version of rclone installed first and won't re-download if not needed.</p>
<h2 id="linux-installation-from-precompiled-binary">Linux installation from precompiled binary</h2>
<p>Fetch and unpack</p>
<pre><code>curl -O https://downloads.rclone.org/rclone-current-linux-amd64.zip
unzip rclone-current-linux-amd64.zip
cd rclone-*-linux-amd64</code></pre>
<p>Copy binary file</p>
<pre><code>sudo cp rclone /usr/bin/
sudo chown root:root /usr/bin/rclone
sudo chmod 755 /usr/bin/rclone</code></pre>
<p>Install manpage</p>
<pre><code>sudo mkdir -p /usr/local/share/man/man1
sudo cp rclone.1 /usr/local/share/man/man1/
sudo mandb </code></pre>
<p>Run <code>rclone config</code> to setup. See <a href="https://rclone.org/docs/">rclone config docs</a> for more details.</p>
<pre><code>rclone config</code></pre>
<h2 id="macos-installation-from-precompiled-binary">macOS installation from precompiled binary</h2>
<p>Download the latest version of rclone.</p>
<pre><code>cd && curl -O https://downloads.rclone.org/rclone-current-osx-amd64.zip</code></pre>
<p>Unzip the download and cd to the extracted folder.</p>
<pre><code>unzip -a rclone-current-osx-amd64.zip && cd rclone-*-osx-amd64</code></pre>
<p>Move rclone to your $PATH. You will be prompted for your password.</p>
<pre><code>sudo mkdir -p /usr/local/bin
sudo mv rclone /usr/local/bin/</code></pre>
<p>(the <code>mkdir</code> command is safe to run, even if the directory already exists).</p>
<p>Remove the leftover files.</p>
<pre><code>cd .. && rm -rf rclone-*-osx-amd64 rclone-current-osx-amd64.zip</code></pre>
<p>Run <code>rclone config</code> to setup. See <a href="https://rclone.org/docs/">rclone config docs</a> for more details.</p>
<pre><code>rclone config</code></pre>
<h2 id="install-from-source">Install from source</h2>
<p>Make sure you have at least <a href="https://golang.org/">Go</a> 1.7 installed. <a href="https://golang.org/dl/">Download go</a> if necessary. The latest release is recommended. Then</p>
<pre><code>git clone https://github.com/ncw/rclone.git
cd rclone
go build
./rclone version</code></pre>
<p>You can also build and install rclone in the <a href="https://github.com/golang/go/wiki/GOPATH">GOPATH</a> (which defaults to <code>~/go</code>) with:</p>
<pre><code>go get -u -v github.com/ncw/rclone</code></pre>
<p>and this will build the binary in <code>$GOPATH/bin</code> (<code>~/go/bin/rclone</code> by default) after downloading the source to <code>$GOPATH/src/github.com/ncw/rclone</code> (<code>~/go/src/github.com/ncw/rclone</code> by default).</p>
<h2 id="installation-with-ansible">Installation with Ansible</h2>
<p>This can be done with <a href="https://github.com/stefangweichinger/ansible-rclone">Stefan Weichinger's ansible role</a>.</p>
<p>Instructions</p>
<ol style="list-style-type: decimal">
<li><code>git clone https://github.com/stefangweichinger/ansible-rclone.git</code> into your local roles-directory</li>
<li>add the role to the hosts you want rclone installed to:</li>
</ol>
<pre><code> - hosts: rclone-hosts
roles:
- rclone</code></pre>
<h2 id="configure">Configure</h2>
<p>First, you'll need to configure rclone. As the object storage systems have quite complicated authentication these are kept in a config file. (See the <code>--config</code> entry for how to find the config file and choose its location.)</p>
<p>The easiest way to make the config is to run rclone with the config option:</p>
<pre><code>rclone config</code></pre>
<p>See the following for detailed instructions for</p>
<ul>
<li><a href="https://rclone.org/alias/">Alias</a></li>
<li><a href="https://rclone.org/amazonclouddrive/">Amazon Drive</a></li>
<li><a href="https://rclone.org/s3/">Amazon S3</a></li>
<li><a href="https://rclone.org/b2/">Backblaze B2</a></li>
<li><a href="https://rclone.org/box/">Box</a></li>
<li><a href="https://rclone.org/cache/">Cache</a></li>
<li><a href="https://rclone.org/crypt/">Crypt</a> - to encrypt other remotes</li>
<li><a href="/s3/#digitalocean-spaces">DigitalOcean Spaces</a></li>
<li><a href="https://rclone.org/dropbox/">Dropbox</a></li>
<li><a href="https://rclone.org/ftp/">FTP</a></li>
<li><a href="https://rclone.org/googlecloudstorage/">Google Cloud Storage</a></li>
<li><a href="https://rclone.org/drive/">Google Drive</a></li>
<li><a href="https://rclone.org/http/">HTTP</a></li>
<li><a href="https://rclone.org/hubic/">Hubic</a></li>
<li><a href="https://rclone.org/jottacloud/">Jottacloud</a></li>
<li><a href="https://rclone.org/mega/">Mega</a></li>
<li><a href="https://rclone.org/azureblob/">Microsoft Azure Blob Storage</a></li>
<li><a href="https://rclone.org/onedrive/">Microsoft OneDrive</a></li>
<li><a href="https://rclone.org/swift/">Openstack Swift / Rackspace Cloudfiles / Memset Memstore</a></li>
<li><a href="https://rclone.org/opendrive/">OpenDrive</a></li>
<li><a href="https://rclone.org/pcloud/">Pcloud</a></li>
<li><a href="https://rclone.org/qingstor/">QingStor</a></li>
<li><a href="https://rclone.org/sftp/">SFTP</a></li>
<li><a href="https://rclone.org/union/">Union</a></li>
<li><a href="https://rclone.org/webdav/">WebDAV</a></li>
<li><a href="https://rclone.org/yandex/">Yandex Disk</a></li>
<li><a href="https://rclone.org/local/">The local filesystem</a></li>
</ul>
<h2 id="usage">Usage</h2>
<p>Rclone syncs a directory tree from one storage system to another.</p>
<p>Its syntax is like this</p>
<pre><code>Syntax: [options] subcommand <parameters> <parameters...></code></pre>
<p>Source and destination paths are specified by the name you gave the storage system in the config file then the sub path, eg "drive:myfolder" to look at "myfolder" in Google drive.</p>
<p>You can define as many storage paths as you like in the config file.</p>
<h2 id="subcommands">Subcommands</h2>
<p>rclone uses a system of subcommands. For example</p>
<pre><code>rclone ls remote:path # lists a re
rclone copy /local/path remote:path # copies /local/path to the remote
rclone sync /local/path remote:path # syncs /local/path to the remote</code></pre>
<h2 id="rclone-config">rclone config</h2>
<p>Enter an interactive configuration session.</p>
<h3 id="synopsis">Synopsis</h3>
<p>Enter an interactive configuration session where you can setup new remotes and manage existing ones. You may also set or remove a password to protect your configuration.</p>
<pre><code>rclone config [flags]</code></pre>
<h3 id="options">Options</h3>
<pre><code> -h, --help help for config</code></pre>
<h2 id="rclone-copy">rclone copy</h2>
<p>Copy files from source to dest, skipping already copied</p>
<h3 id="synopsis-1">Synopsis</h3>
<p>Copy the source to the destination. Doesn't transfer unchanged files, testing by size and modification time or MD5SUM. Doesn't delete files from the destination.</p>
<p>Note that it is always the contents of the directory that is synced, not the directory so when source:path is a directory, it's the contents of source:path that are copied, not the directory name and contents.</p>
<p>If dest:path doesn't exist, it is created and the source:path contents go there.</p>
<p>For example</p>
<pre><code>rclone copy source:sourcepath dest:destpath</code></pre>
<p>Let's say there are two files in sourcepath</p>
<pre><code>sourcepath/one.txt
sourcepath/two.txt</code></pre>
<p>This copies them to</p>
<pre><code>destpath/one.txt
destpath/two.txt</code></pre>
<p>Not to</p>
<pre><code>destpath/sourcepath/one.txt
destpath/sourcepath/two.txt</code></pre>
<p>If you are familiar with <code>rsync</code>, rclone always works as if you had written a trailing / - meaning "copy the contents of this directory". This applies to all commands and whether you are talking about the source or destination.</p>
<pre><code>rclone copy source:path dest:path [flags]</code></pre>
<h3 id="options-1">Options</h3>
<pre><code> -h, --help help for copy</code></pre>
<h2 id="rclone-sync">rclone sync</h2>
<p>Make source and dest identical, modifying destination only.</p>
<h3 id="synopsis-2">Synopsis</h3>
<p>Sync the source to the destination, changing the destination only. Doesn't transfer unchanged files, testing by size and modification time or MD5SUM. Destination is updated to match source, including deleting files if necessary.</p>
<p><strong>Important</strong>: Since this can cause data loss, test first with the <code>--dry-run</code> flag to see exactly what would be copied and deleted.</p>
<p>Note that files in the destination won't be deleted if there were any errors at any point.</p>
<p>It is always the contents of the directory that is synced, not the directory so when source:path is a directory, it's the contents of source:path that are copied, not the directory name and contents. See extended explanation in the <code>copy</code> command above if unsure.</p>
<p>If dest:path doesn't exist, it is created and the source:path contents go there.</p>
<pre><code>rclone sync source:path dest:path [flags]</code></pre>
<h3 id="options-2">Options</h3>
<pre><code> -h, --help help for sync</code></pre>
<h2 id="rclone-move">rclone move</h2>
<p>Move files from source to dest.</p>
<h3 id="synopsis-3">Synopsis</h3>
<p>Moves the contents of the source directory to the destination directory. Rclone will error if the source and destination overlap and the remote does not support a server side directory move operation.</p>
<p>If no filters are in use and if possible this will server side move <code>source:path</code> into <code>dest:path</code>. After this <code>source:path</code> will no longer longer exist.</p>
<p>Otherwise for each file in <code>source:path</code> selected by the filters (if any) this will move it into <code>dest:path</code>. If possible a server side move will be used, otherwise it will copy it (server side if possible) into <code>dest:path</code> then delete the original (if no errors on copy) in <code>source:path</code>.</p>
<p>If you want to delete empty source directories after move, use the --delete-empty-src-dirs flag.</p>
<p><strong>Important</strong>: Since this can cause data loss, test first with the --dry-run flag.</p>
<pre><code>rclone move source:path dest:path [flags]</code></pre>
<h3 id="options-3">Options</h3>
<pre><code> --delete-empty-src-dirs Delete empty source dirs after move
-h, --help help for move</code></pre>
<h2 id="rclone-delete">rclone delete</h2>
<p>Remove the contents of path.</p>
<h3 id="synopsis-4">Synopsis</h3>
<p>Remove the contents of path. Unlike <code>purge</code> it obeys include/exclude filters so can be used to selectively delete files.</p>
<p>Eg delete all files bigger than 100MBytes</p>
<p>Check what would be deleted first (use either)</p>
<pre><code>rclone --min-size 100M lsl remote:path
rclone --dry-run --min-size 100M delete remote:path</code></pre>
<p>Then delete</p>
<pre><code>rclone --min-size 100M delete remote:path</code></pre>
<p>That reads "delete everything with a minimum size of 100 MB", hence delete all files bigger than 100MBytes.</p>
<pre><code>rclone delete remote:path [flags]</code></pre>
<h3 id="options-4">Options</h3>
<pre><code> -h, --help help for delete</code></pre>
<h2 id="rclone-purge">rclone purge</h2>
<p>Remove the path and all of its contents.</p>
<h3 id="synopsis-5">Synopsis</h3>
<p>Remove the path and all of its contents. Note that this does not obey include/exclude filters - everything will be removed. Use <code>delete</code> if you want to selectively delete files.</p>
<pre><code>rclone purge remote:path [flags]</code></pre>
<h3 id="options-5">Options</h3>
<pre><code> -h, --help help for purge</code></pre>
<h2 id="rclone-mkdir">rclone mkdir</h2>
<p>Make the path if it doesn't already exist.</p>
<h3 id="synopsis-6">Synopsis</h3>
<p>Make the path if it doesn't already exist.</p>
<pre><code>rclone mkdir remote:path [flags]</code></pre>
<h3 id="options-6">Options</h3>
<pre><code> -h, --help help for mkdir</code></pre>
<h2 id="rclone-rmdir">rclone rmdir</h2>
<p>Remove the path if empty.</p>
<h3 id="synopsis-7">Synopsis</h3>
<p>Remove the path. Note that you can't remove a path with objects in it, use purge for that.</p>
<pre><code>rclone rmdir remote:path [flags]</code></pre>
<h3 id="options-7">Options</h3>
<pre><code> -h, --help help for rmdir</code></pre>
<h2 id="rclone-check">rclone check</h2>
<p>Checks the files in the source and destination match.</p>
<h3 id="synopsis-8">Synopsis</h3>
<p>Checks the files in the source and destination match. It compares sizes and hashes (MD5 or SHA1) and logs a report of files which don't match. It doesn't alter the source or destination.</p>
<p>If you supply the --size-only flag, it will only compare the sizes not the hashes as well. Use this for a quick check.</p>
<p>If you supply the --download flag, it will download the data from both remotes and check them against each other on the fly. This can be useful for remotes that don't support hashes or if you really want to check all the data.</p>
<p>If you supply the --one-way flag, it will only check that files in source match the files in destination, not the other way around. Meaning extra files in destination that are not in the source will not trigger an error.</p>
<pre><code>rclone check source:path dest:path [flags]</code></pre>
<h3 id="options-8">Options</h3>
<pre><code> --download Check by downloading rather than with hash.
-h, --help help for check
--one-way Check one way only, source files must exist on remote</code></pre>
<h2 id="rclone-ls">rclone ls</h2>
<p>List the objects in the path with size and path.</p>
<h3 id="synopsis-9">Synopsis</h3>
<p>Lists the objects in the source path to standard output in a human readable format with size and path. Recurses by default.</p>
<p>Eg</p>
<pre><code>$ rclone ls swift:bucket
60295 bevajer5jef
90613 canole
94467 diwogej7
37600 fubuwic</code></pre>
<p>Any of the filtering options can be applied to this commmand.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse format</li>
<li><code>lsjson</code> to list objects and directories in JSON format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use "--max-depth 1" to stop the recursion.</p>
<p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use "-R" to make them recurse.</p>
<p>Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p>
<pre><code>rclone ls remote:path [flags]</code></pre>
<h3 id="options-9">Options</h3>
<pre><code> -h, --help help for ls</code></pre>
<h2 id="rclone-lsd">rclone lsd</h2>
<p>List all directories/containers/buckets in the path.</p>
<h3 id="synopsis-10">Synopsis</h3>
<p>Lists the directories in the source path to standard output. Does not recurse by default. Use the -R flag to recurse.</p>
<p>This command lists the total size of the directory (if known, -1 if not), the modification time (if known, the current time if not), the number of objects in the directory (if known, -1 if not) and the name of the directory, Eg</p>
<pre><code>$ rclone lsd swift:
494000 2018-04-26 08:43:20 10000 10000files
65 2018-04-26 08:43:20 1 1File</code></pre>
<p>Or</p>
<pre><code>$ rclone lsd drive:test
-1 2016-10-17 17:41:53 -1 1000files
-1 2017-01-03 14:40:54 -1 2500files
-1 2017-07-08 14:39:28 -1 4000files</code></pre>
<p>If you just want the directory names use "rclone lsf --dirs-only".</p>
<p>Any of the filtering options can be applied to this commmand.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse format</li>
<li><code>lsjson</code> to list objects and directories in JSON format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use "--max-depth 1" to stop the recursion.</p>
<p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use "-R" to make them recurse.</p>
<p>Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p>
<pre><code>rclone lsd remote:path [flags]</code></pre>
<h3 id="options-10">Options</h3>
<pre><code> -h, --help help for lsd
-R, --recursive Recurse into the listing.</code></pre>
<h2 id="rclone-lsl">rclone lsl</h2>
<p>List the objects in path with modification time, size and path.</p>
<h3 id="synopsis-11">Synopsis</h3>
<p>Lists the objects in the source path to standard output in a human readable format with modification time, size and path. Recurses by default.</p>
<p>Eg</p>
<pre><code>$ rclone lsl swift:bucket
60295 2016-06-25 18:55:41.062626927 bevajer5jef
90613 2016-06-25 18:55:43.302607074 canole
94467 2016-06-25 18:55:43.046609333 diwogej7
37600 2016-06-25 18:55:40.814629136 fubuwic</code></pre>
<p>Any of the filtering options can be applied to this commmand.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse format</li>
<li><code>lsjson</code> to list objects and directories in JSON format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use "--max-depth 1" to stop the recursion.</p>
<p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use "-R" to make them recurse.</p>
<p>Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p>
<pre><code>rclone lsl remote:path [flags]</code></pre>
<h3 id="options-11">Options</h3>
<pre><code> -h, --help help for lsl</code></pre>
<h2 id="rclone-md5sum">rclone md5sum</h2>
<p>Produces an md5sum file for all the objects in the path.</p>
<h3 id="synopsis-12">Synopsis</h3>
<p>Produces an md5sum file for all the objects in the path. This is in the same format as the standard md5sum tool produces.</p>
<pre><code>rclone md5sum remote:path [flags]</code></pre>
<h3 id="options-12">Options</h3>
<pre><code> -h, --help help for md5sum</code></pre>
<h2 id="rclone-sha1sum">rclone sha1sum</h2>
<p>Produces an sha1sum file for all the objects in the path.</p>
<h3 id="synopsis-13">Synopsis</h3>
<p>Produces an sha1sum file for all the objects in the path. This is in the same format as the standard sha1sum tool produces.</p>
<pre><code>rclone sha1sum remote:path [flags]</code></pre>
<h3 id="options-13">Options</h3>
<pre><code> -h, --help help for sha1sum</code></pre>
<h2 id="rclone-size">rclone size</h2>
<p>Prints the total size and number of objects in remote:path.</p>
<h3 id="synopsis-14">Synopsis</h3>
<p>Prints the total size and number of objects in remote:path.</p>
<pre><code>rclone size remote:path [flags]</code></pre>
<h3 id="options-14">Options</h3>
<pre><code> -h, --help help for size
--json format output as JSON</code></pre>
<h2 id="rclone-version">rclone version</h2>
<p>Show the version number.</p>
<h3 id="synopsis-15">Synopsis</h3>
<p>Show the version number, the go version and the architecture.</p>
<p>Eg</p>
<pre><code>$ rclone version
rclone v1.41
- os/arch: linux/amd64
- go version: go1.10</code></pre>
<p>If you supply the --check flag, then it will do an online check to compare your version with the latest release and the latest beta.</p>
<pre><code>$ rclone version --check
yours: 1.42.0.6
latest: 1.42 (released 2018-06-16)
beta: 1.42.0.5 (released 2018-06-17)</code></pre>
<p>Or</p>
<pre><code>$ rclone version --check
yours: 1.41
latest: 1.42 (released 2018-06-16)
upgrade: https://downloads.rclone.org/v1.42
beta: 1.42.0.5 (released 2018-06-17)
upgrade: https://beta.rclone.org/v1.42-005-g56e1e820</code></pre>
<pre><code>rclone version [flags]</code></pre>
<h3 id="options-15">Options</h3>
<pre><code> --check Check for new version.
-h, --help help for version</code></pre>
<h2 id="rclone-cleanup">rclone cleanup</h2>
<p>Clean up the remote if possible</p>
<h3 id="synopsis-16">Synopsis</h3>
<p>Clean up the remote if possible. Empty the trash or delete old file versions. Not supported by all remotes.</p>
<pre><code>rclone cleanup remote:path [flags]</code></pre>
<h3 id="options-16">Options</h3>
<pre><code> -h, --help help for cleanup</code></pre>
<h2 id="rclone-dedupe">rclone dedupe</h2>
<p>Interactively find duplicate files and delete/rename them.</p>
<h3 id="synopsis-17">Synopsis</h3>
<p>By default <code>dedupe</code> interactively finds duplicate files and offers to delete all but one or rename them to be different. Only useful with Google Drive which can have duplicate file names.</p>
<p>In the first pass it will merge directories with the same name. It will do this iteratively until all the identical directories have been merged.</p>
<p>The <code>dedupe</code> command will delete all but one of any identical (same md5sum) files it finds without confirmation. This means that for most duplicated files the <code>dedupe</code> command will not be interactive. You can use <code>--dry-run</code> to see what would happen without doing anything.</p>
<p>Here is an example run.</p>
<p>Before - with duplicates</p>
<pre><code>$ rclone lsl drive:dupes
6048320 2016-03-05 16:23:16.798000000 one.txt
6048320 2016-03-05 16:23:11.775000000 one.txt
564374 2016-03-05 16:23:06.731000000 one.txt
6048320 2016-03-05 16:18:26.092000000 one.txt
6048320 2016-03-05 16:22:46.185000000 two.txt
1744073 2016-03-05 16:22:38.104000000 two.txt
564374 2016-03-05 16:22:52.118000000 two.txt</code></pre>
<p>Now the <code>dedupe</code> session</p>
<pre><code>$ rclone dedupe drive:dupes
2016/03/05 16:24:37 Google drive root 'dupes': Looking for duplicates using interactive mode.
one.txt: Found 4 duplicates - deleting identical copies
one.txt: Deleting 2/3 identical duplicates (md5sum "1eedaa9fe86fd4b8632e2ac549403b36")
one.txt: 2 duplicates remain
1: 6048320 bytes, 2016-03-05 16:23:16.798000000, md5sum 1eedaa9fe86fd4b8632e2ac549403b36
2: 564374 bytes, 2016-03-05 16:23:06.731000000, md5sum 7594e7dc9fc28f727c42ee3e0749de81
s) Skip and do nothing
k) Keep just one (choose which in next step)
r) Rename all to be different (by changing file.jpg to file-1.jpg)
s/k/r> k
Enter the number of the file to keep> 1
one.txt: Deleted 1 extra copies
two.txt: Found 3 duplicates - deleting identical copies
two.txt: 3 duplicates remain
1: 564374 bytes, 2016-03-05 16:22:52.118000000, md5sum 7594e7dc9fc28f727c42ee3e0749de81
2: 6048320 bytes, 2016-03-05 16:22:46.185000000, md5sum 1eedaa9fe86fd4b8632e2ac549403b36
3: 1744073 bytes, 2016-03-05 16:22:38.104000000, md5sum 851957f7fb6f0bc4ce76be966d336802
s) Skip and do nothing
k) Keep just one (choose which in next step)
r) Rename all to be different (by changing file.jpg to file-1.jpg)
s/k/r> r
two-1.txt: renamed from: two.txt
two-2.txt: renamed from: two.txt
two-3.txt: renamed from: two.txt</code></pre>
<p>The result being</p>
<pre><code>$ rclone lsl drive:dupes
6048320 2016-03-05 16:23:16.798000000 one.txt
564374 2016-03-05 16:22:52.118000000 two-1.txt
6048320 2016-03-05 16:22:46.185000000 two-2.txt
1744073 2016-03-05 16:22:38.104000000 two-3.txt</code></pre>
<p>Dedupe can be run non interactively using the <code>--dedupe-mode</code> flag or by using an extra parameter with the same value</p>
<ul>
<li><code>--dedupe-mode interactive</code> - interactive as above.</li>
<li><code>--dedupe-mode skip</code> - removes identical files then skips anything left.</li>
<li><code>--dedupe-mode first</code> - removes identical files then keeps the first one.</li>
<li><code>--dedupe-mode newest</code> - removes identical files then keeps the newest one.</li>
<li><code>--dedupe-mode oldest</code> - removes identical files then keeps the oldest one.</li>
<li><code>--dedupe-mode largest</code> - removes identical files then keeps the largest one.</li>
<li><code>--dedupe-mode rename</code> - removes identical files then renames the rest to be different.</li>
</ul>
<p>For example to rename all the identically named photos in your Google Photos directory, do</p>
<pre><code>rclone dedupe --dedupe-mode rename "drive:Google Photos"</code></pre>
<p>Or</p>
<pre><code>rclone dedupe rename "drive:Google Photos"</code></pre>
<pre><code>rclone dedupe [mode] remote:path [flags]</code></pre>
<h3 id="options-17">Options</h3>
<pre><code> --dedupe-mode string Dedupe mode interactive|skip|first|newest|oldest|rename. (default "interactive")
-h, --help help for dedupe</code></pre>
<h2 id="rclone-about">rclone about</h2>
<p>Get quota information from the remote.</p>
<h3 id="synopsis-18">Synopsis</h3>
<p>Get quota information from the remote, like bytes used/free/quota and bytes used in the trash. Not supported by all remotes.</p>
<p>This will print to stdout something like this:</p>
<pre><code>Total: 17G
Used: 7.444G
Free: 1.315G
Trashed: 100.000M
Other: 8.241G</code></pre>
<p>Where the fields are:</p>
<ul>
<li>Total: total size available.</li>
<li>Used: total size used</li>
<li>Free: total amount this user could upload.</li>
<li>Trashed: total amount in the trash</li>
<li>Other: total amount in other storage (eg Gmail, Google Photos)</li>
<li>Objects: total number of objects in the storage</li>
</ul>
<p>Note that not all the backends provide all the fields - they will be missing if they are not known for that backend. Where it is known that the value is unlimited the value will also be omitted.</p>
<p>Use the --full flag to see the numbers written out in full, eg</p>
<pre><code>Total: 18253611008
Used: 7993453766
Free: 1411001220
Trashed: 104857602
Other: 8849156022</code></pre>
<p>Use the --json flag for a computer readable output, eg</p>
<pre><code>{
"total": 18253611008,
"used": 7993453766,
"trashed": 104857602,
"other": 8849156022,
"free": 1411001220
}</code></pre>
<pre><code>rclone about remote: [flags]</code></pre>
<h3 id="options-18">Options</h3>
<pre><code> --full Full numbers instead of SI units
-h, --help help for about
--json Format output as JSON</code></pre>
<h2 id="rclone-authorize">rclone authorize</h2>
<p>Remote authorization.</p>
<h3 id="synopsis-19">Synopsis</h3>
<p>Remote authorization. Used to authorize a remote or headless rclone from a machine with a browser - use as instructed by rclone config.</p>
<pre><code>rclone authorize [flags]</code></pre>
<h3 id="options-19">Options</h3>
<pre><code> -h, --help help for authorize</code></pre>
<h2 id="rclone-cachestats">rclone cachestats</h2>
<p>Print cache stats for a remote</p>
<h3 id="synopsis-20">Synopsis</h3>
<p>Print cache stats for a remote in JSON format</p>
<pre><code>rclone cachestats source: [flags]</code></pre>
<h3 id="options-20">Options</h3>
<pre><code> -h, --help help for cachestats</code></pre>
<h2 id="rclone-cat">rclone cat</h2>
<p>Concatenates any files and sends them to stdout.</p>
<h3 id="synopsis-21">Synopsis</h3>
<p>rclone cat sends any files to standard output.</p>
<p>You can use it like this to output a single file</p>
<pre><code>rclone cat remote:path/to/file</code></pre>
<p>Or like this to output any file in dir or subdirectories.</p>
<pre><code>rclone cat remote:path/to/dir</code></pre>
<p>Or like this to output any .txt files in dir or subdirectories.</p>
<pre><code>rclone --include "*.txt" cat remote:path/to/dir</code></pre>
<p>Use the --head flag to print characters only at the start, --tail for the end and --offset and --count to print a section in the middle. Note that if offset is negative it will count from the end, so --offset -1 --count 1 is equivalent to --tail 1.</p>
<pre><code>rclone cat remote:path [flags]</code></pre>
<h3 id="options-21">Options</h3>
<pre><code> --count int Only print N characters. (default -1)
--discard Discard the output instead of printing.
--head int Only print the first N characters.
-h, --help help for cat
--offset int Start printing at offset N (or from end if -ve).
--tail int Only print the last N characters.</code></pre>
<h2 id="rclone-config-create">rclone config create</h2>
<p>Create a new remote with name, type and options.</p>
<h3 id="synopsis-22">Synopsis</h3>
<p>Create a new remote of <name> with <type> and options. The options should be passed in in pairs of <key> <value>.</p>
<p>For example to make a swift remote of name myremote using auto config you would do:</p>
<pre><code>rclone config create myremote swift env_auth true</code></pre>
<pre><code>rclone config create <name> <type> [<key> <value>]* [flags]</code></pre>
<h3 id="options-22">Options</h3>
<pre><code> -h, --help help for create</code></pre>
<h2 id="rclone-config-delete">rclone config delete</h2>
<p>Delete an existing remote <name>.</p>
<h3 id="synopsis-23">Synopsis</h3>
<p>Delete an existing remote <name>.</p>
<pre><code>rclone config delete <name> [flags]</code></pre>
<h3 id="options-23">Options</h3>
<pre><code> -h, --help help for delete</code></pre>
<h2 id="rclone-config-dump">rclone config dump</h2>
<p>Dump the config file as JSON.</p>
<h3 id="synopsis-24">Synopsis</h3>
<p>Dump the config file as JSON.</p>
<pre><code>rclone config dump [flags]</code></pre>
<h3 id="options-24">Options</h3>
<pre><code> -h, --help help for dump</code></pre>
<h2 id="rclone-config-edit">rclone config edit</h2>
<p>Enter an interactive configuration session.</p>
<h3 id="synopsis-25">Synopsis</h3>
<p>Enter an interactive configuration session where you can setup new remotes and manage existing ones. You may also set or remove a password to protect your configuration.</p>
<pre><code>rclone config edit [flags]</code></pre>
<h3 id="options-25">Options</h3>
<pre><code> -h, --help help for edit</code></pre>
<h2 id="rclone-config-file">rclone config file</h2>
<p>Show path of configuration file in use.</p>
<h3 id="synopsis-26">Synopsis</h3>
<p>Show path of configuration file in use.</p>
<pre><code>rclone config file [flags]</code></pre>
<h3 id="options-26">Options</h3>
<pre><code> -h, --help help for file</code></pre>
<h2 id="rclone-config-password">rclone config password</h2>
<p>Update password in an existing remote.</p>
<h3 id="synopsis-27">Synopsis</h3>
<p>Update an existing remote's password. The password should be passed in in pairs of <key> <value>.</p>
<p>For example to set password of a remote of name myremote you would do:</p>
<pre><code>rclone config password myremote fieldname mypassword</code></pre>
<pre><code>rclone config password <name> [<key> <value>]+ [flags]</code></pre>
<h3 id="options-27">Options</h3>
<pre><code> -h, --help help for password</code></pre>
<h2 id="rclone-config-providers">rclone config providers</h2>
<p>List in JSON format all the providers and options.</p>
<h3 id="synopsis-28">Synopsis</h3>
<p>List in JSON format all the providers and options.</p>
<pre><code>rclone config providers [flags]</code></pre>
<h3 id="options-28">Options</h3>
<pre><code> -h, --help help for providers</code></pre>
<h2 id="rclone-config-show">rclone config show</h2>
<p>Print (decrypted) config file, or the config for a single remote.</p>
<h3 id="synopsis-29">Synopsis</h3>
<p>Print (decrypted) config file, or the config for a single remote.</p>
<pre><code>rclone config show [<remote>] [flags]</code></pre>
<h3 id="options-29">Options</h3>
<pre><code> -h, --help help for show</code></pre>
<h2 id="rclone-config-update">rclone config update</h2>
<p>Update options in an existing remote.</p>
<h3 id="synopsis-30">Synopsis</h3>
<p>Update an existing remote's options. The options should be passed in in pairs of <key> <value>.</p>
<p>For example to update the env_auth field of a remote of name myremote you would do:</p>
<pre><code>rclone config update myremote swift env_auth true</code></pre>
<pre><code>rclone config update <name> [<key> <value>]+ [flags]</code></pre>
<h3 id="options-30">Options</h3>
<pre><code> -h, --help help for update</code></pre>
<h2 id="rclone-copyto">rclone copyto</h2>
<p>Copy files from source to dest, skipping already copied</p>
<h3 id="synopsis-31">Synopsis</h3>
<p>If source:path is a file or directory then it copies it to a file or directory named dest:path.</p>
<p>This can be used to upload single files to other than their current name. If the source is a directory then it acts exactly like the copy command.</p>
<p>So</p>
<pre><code>rclone copyto src dst</code></pre>
<p>where src and dst are rclone paths, either remote:path or /path/to/local or C:.</p>
<p>This will:</p>
<pre><code>if src is file
copy it to dst, overwriting an existing file if it exists
if src is directory
copy it to dst, overwriting existing files if they exist
see copy command for full details</code></pre>
<p>This doesn't transfer unchanged files, testing by size and modification time or MD5SUM. It doesn't delete files from the destination.</p>
<pre><code>rclone copyto source:path dest:path [flags]</code></pre>
<h3 id="options-31">Options</h3>
<pre><code> -h, --help help for copyto</code></pre>
<h2 id="rclone-copyurl">rclone copyurl</h2>
<p>Copy url content to dest.</p>
<h3 id="synopsis-32">Synopsis</h3>
<p>Download urls content and copy it to destination without saving it in tmp storage.</p>
<pre><code>rclone copyurl https://example.com dest:path [flags]</code></pre>
<h3 id="options-32">Options</h3>
<pre><code> -h, --help help for copyurl</code></pre>
<h2 id="rclone-cryptcheck">rclone cryptcheck</h2>
<p>Cryptcheck checks the integrity of a crypted remote.</p>
<h3 id="synopsis-33">Synopsis</h3>
<p>rclone cryptcheck checks a remote against a crypted remote. This is the equivalent of running rclone check, but able to check the checksums of the crypted remote.</p>
<p>For it to work the underlying remote of the cryptedremote must support some kind of checksum.</p>
<p>It works by reading the nonce from each file on the cryptedremote: and using that to encrypt each file on the remote:. It then checks the checksum of the underlying file on the cryptedremote: against the checksum of the file it has just encrypted.</p>
<p>Use it like this</p>
<pre><code>rclone cryptcheck /path/to/files encryptedremote:path</code></pre>
<p>You can use it like this also, but that will involve downloading all the files in remote:path.</p>
<pre><code>rclone cryptcheck remote:path encryptedremote:path</code></pre>
<p>After it has run it will log the status of the encryptedremote:.</p>
<p>If you supply the --one-way flag, it will only check that files in source match the files in destination, not the other way around. Meaning extra files in destination that are not in the source will not trigger an error.</p>
<pre><code>rclone cryptcheck remote:path cryptedremote:path [flags]</code></pre>
<h3 id="options-33">Options</h3>
<pre><code> -h, --help help for cryptcheck
--one-way Check one way only, source files must exist on destination</code></pre>
<h2 id="rclone-cryptdecode">rclone cryptdecode</h2>
<p>Cryptdecode returns unencrypted file names.</p>
<h3 id="synopsis-34">Synopsis</h3>
<p>rclone cryptdecode returns unencrypted file names when provided with a list of encrypted file names. List limit is 10 items.</p>
<p>If you supply the --reverse flag, it will return encrypted file names.</p>
<p>use it like this</p>
<pre><code>rclone cryptdecode encryptedremote: encryptedfilename1 encryptedfilename2
rclone cryptdecode --reverse encryptedremote: filename1 filename2</code></pre>
<pre><code>rclone cryptdecode encryptedremote: encryptedfilename [flags]</code></pre>
<h3 id="options-34">Options</h3>
<pre><code> -h, --help help for cryptdecode
--reverse Reverse cryptdecode, encrypts filenames</code></pre>
<h2 id="rclone-dbhashsum">rclone dbhashsum</h2>
<p>Produces a Dropbox hash file for all the objects in the path.</p>
<h3 id="synopsis-35">Synopsis</h3>
<p>Produces a Dropbox hash file for all the objects in the path. The hashes are calculated according to <a href="https://www.dropbox.com/developers/reference/content-hash">Dropbox content hash rules</a>. The output is in the same format as md5sum and sha1sum.</p>
<pre><code>rclone dbhashsum remote:path [flags]</code></pre>
<h3 id="options-35">Options</h3>
<pre><code> -h, --help help for dbhashsum</code></pre>
<h2 id="rclone-deletefile">rclone deletefile</h2>
<p>Remove a single file from remote.</p>
<h3 id="synopsis-36">Synopsis</h3>
<p>Remove a single file from remote. Unlike <code>delete</code> it cannot be used to remove a directory and it doesn't obey include/exclude filters - if the specified file exists, it will always be removed.</p>
<pre><code>rclone deletefile remote:path [flags]</code></pre>
<h3 id="options-36">Options</h3>
<pre><code> -h, --help help for deletefile</code></pre>
<h2 id="rclone-genautocomplete">rclone genautocomplete</h2>
<p>Output completion script for a given shell.</p>
<h3 id="synopsis-37">Synopsis</h3>
<p>Generates a shell completion script for rclone. Run with --help to list the supported shells.</p>
<h3 id="options-37">Options</h3>
<pre><code> -h, --help help for genautocomplete</code></pre>
<h2 id="rclone-genautocomplete-bash">rclone genautocomplete bash</h2>
<p>Output bash completion script for rclone.</p>
<h3 id="synopsis-38">Synopsis</h3>
<p>Generates a bash shell autocompletion script for rclone.</p>
<p>This writes to /etc/bash_completion.d/rclone by default so will probably need to be run with sudo or as root, eg</p>
<pre><code>sudo rclone genautocomplete bash</code></pre>
<p>Logout and login again to use the autocompletion scripts, or source them directly</p>
<pre><code>. /etc/bash_completion</code></pre>
<p>If you supply a command line argument the script will be written there.</p>
<pre><code>rclone genautocomplete bash [output_file] [flags]</code></pre>
<h3 id="options-38">Options</h3>
<pre><code> -h, --help help for bash</code></pre>
<h2 id="rclone-genautocomplete-zsh">rclone genautocomplete zsh</h2>
<p>Output zsh completion script for rclone.</p>
<h3 id="synopsis-39">Synopsis</h3>
<p>Generates a zsh autocompletion script for rclone.</p>
<p>This writes to /usr/share/zsh/vendor-completions/_rclone by default so will probably need to be run with sudo or as root, eg</p>
<pre><code>sudo rclone genautocomplete zsh</code></pre>
<p>Logout and login again to use the autocompletion scripts, or source them directly</p>
<pre><code>autoload -U compinit && compinit</code></pre>
<p>If you supply a command line argument the script will be written there.</p>
<pre><code>rclone genautocomplete zsh [output_file] [flags]</code></pre>
<h3 id="options-39">Options</h3>
<pre><code> -h, --help help for zsh</code></pre>
<h2 id="rclone-gendocs">rclone gendocs</h2>
<p>Output markdown docs for rclone to the directory supplied.</p>
<h3 id="synopsis-40">Synopsis</h3>
<p>This produces markdown docs for the rclone commands to the directory supplied. These are in a format suitable for hugo to render into the rclone.org website.</p>
<pre><code>rclone gendocs output_directory [flags]</code></pre>
<h3 id="options-40">Options</h3>
<pre><code> -h, --help help for gendocs</code></pre>
<h2 id="rclone-hashsum">rclone hashsum</h2>
<p>Produces an hashsum file for all the objects in the path.</p>
<h3 id="synopsis-41">Synopsis</h3>
<p>Produces a hash file for all the objects in the path using the hash named. The output is in the same format as the standard md5sum/sha1sum tool.</p>
<p>Run without a hash to see the list of supported hashes, eg</p>
<pre><code>$ rclone hashsum
Supported hashes are:
* MD5
* SHA-1
* DropboxHash
* QuickXorHash</code></pre>
<p>Then</p>
<pre><code>$ rclone hashsum MD5 remote:path</code></pre>
<pre><code>rclone hashsum <hash> remote:path [flags]</code></pre>
<h3 id="options-41">Options</h3>
<pre><code> -h, --help help for hashsum</code></pre>
<h2 id="rclone-link">rclone link</h2>
<p>Generate public link to file/folder.</p>
<h3 id="synopsis-42">Synopsis</h3>
<p>rclone link will create or retrieve a public link to the given file or folder.</p>
<pre><code>rclone link remote:path/to/file
rclone link remote:path/to/folder/</code></pre>
<p>If successful, the last line of the output will contain the link. Exact capabilities depend on the remote, but the link will always be created with the least constraints – e.g. no expiry, no password protection, accessible without account.</p>
<pre><code>rclone link remote:path [flags]</code></pre>
<h3 id="options-42">Options</h3>
<pre><code> -h, --help help for link</code></pre>
<h2 id="rclone-listremotes">rclone listremotes</h2>
<p>List all the remotes in the config file.</p>
<h3 id="synopsis-43">Synopsis</h3>
<p>rclone listremotes lists all the available remotes from the config file.</p>
<p>When uses with the -l flag it lists the types too.</p>
<pre><code>rclone listremotes [flags]</code></pre>
<h3 id="options-43">Options</h3>
<pre><code> -h, --help help for listremotes
-l, --long Show the type as well as names.</code></pre>
<h2 id="rclone-lsf">rclone lsf</h2>
<p>List directories and objects in remote:path formatted for parsing</p>
<h3 id="synopsis-44">Synopsis</h3>
<p>List the contents of the source path (directories and objects) to standard output in a form which is easy to parse by scripts. By default this will just be the names of the objects and directories, one per line. The directories will have a / suffix.</p>
<p>Eg</p>
<pre><code>$ rclone lsf swift:bucket
bevajer5jef
canole
diwogej7
ferejej3gux/
fubuwic</code></pre>
<p>Use the --format option to control what gets listed. By default this is just the path, but you can use these parameters to control the output:</p>
<pre><code>p - path
s - size
t - modification time
h - hash
i - ID of object if known
m - MimeType of object if known</code></pre>
<p>So if you wanted the path, size and modification time, you would use --format "pst", or maybe --format "tsp" to put the path last.</p>
<p>Eg</p>
<pre><code>$ rclone lsf --format "tsp" swift:bucket
2016-06-25 18:55:41;60295;bevajer5jef
2016-06-25 18:55:43;90613;canole
2016-06-25 18:55:43;94467;diwogej7
2018-04-26 08:50:45;0;ferejej3gux/
2016-06-25 18:55:40;37600;fubuwic</code></pre>
<p>If you specify "h" in the format you will get the MD5 hash by default, use the "--hash" flag to change which hash you want. Note that this can be returned as an empty string if it isn't available on the object (and for directories), "ERROR" if there was an error reading it from the object and "UNSUPPORTED" if that object does not support that hash type.</p>
<p>For example to emulate the md5sum command you can use</p>
<pre><code>rclone lsf -R --hash MD5 --format hp --separator " " --files-only .</code></pre>
<p>Eg</p>
<pre><code>$ rclone lsf -R --hash MD5 --format hp --separator " " --files-only swift:bucket
7908e352297f0f530b84a756f188baa3 bevajer5jef
cd65ac234e6fea5925974a51cdd865cc canole
03b5341b4f234b9d984d03ad076bae91 diwogej7
8fd37c3810dd660778137ac3a66cc06d fubuwic
99713e14a4c4ff553acaf1930fad985b gixacuh7ku</code></pre>
<p>(Though "rclone md5sum ." is an easier way of typing this.)</p>
<p>By default the separator is ";" this can be changed with the --separator flag. Note that separators aren't escaped in the path so putting it last is a good strategy.</p>
<p>Eg</p>
<pre><code>$ rclone lsf --separator "," --format "tshp" swift:bucket
2016-06-25 18:55:41,60295,7908e352297f0f530b84a756f188baa3,bevajer5jef
2016-06-25 18:55:43,90613,cd65ac234e6fea5925974a51cdd865cc,canole
2016-06-25 18:55:43,94467,03b5341b4f234b9d984d03ad076bae91,diwogej7
2018-04-26 08:52:53,0,,ferejej3gux/
2016-06-25 18:55:40,37600,8fd37c3810dd660778137ac3a66cc06d,fubuwic</code></pre>
<p>You can output in CSV standard format. This will escape things in " if they contain ,</p>
<p>Eg</p>
<pre><code>$ rclone lsf --csv --files-only --format ps remote:path
test.log,22355
test.sh,449
"this file contains a comma, in the file name.txt",6</code></pre>
<p>Note that the --absolute parameter is useful for making lists of files to pass to an rclone copy with the --files-from flag.</p>
<p>For example to find all the files modified within one day and copy those only (without traversing the whole directory structure):</p>
<pre><code>rclone lsf --absolute --files-only --max-age 1d /path/to/local > new_files
rclone copy --files-from new_files /path/to/local remote:path</code></pre>
<p>Any of the filtering options can be applied to this commmand.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse format</li>
<li><code>lsjson</code> to list objects and directories in JSON format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use "--max-depth 1" to stop the recursion.</p>
<p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use "-R" to make them recurse.</p>
<p>Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p>
<pre><code>rclone lsf remote:path [flags]</code></pre>
<h3 id="options-44">Options</h3>
<pre><code> --absolute Put a leading / in front of path names.
--csv Output in CSV format.
-d, --dir-slash Append a slash to directory names. (default true)
--dirs-only Only list directories.
--files-only Only list files.
-F, --format string Output format - see help for details (default "p")
--hash h Use this hash when h is used in the format MD5|SHA-1|DropboxHash (default "MD5")
-h, --help help for lsf
-R, --recursive Recurse into the listing.
-s, --separator string Separator for the items in the format. (default ";")</code></pre>
<h2 id="rclone-lsjson">rclone lsjson</h2>
<p>List directories and objects in the path in JSON format.</p>
<h3 id="synopsis-45">Synopsis</h3>
<p>List directories and objects in the path in JSON format.</p>
<p>The output is an array of Items, where each Item looks like this</p>
<p>{ "Hashes" : { "SHA-1" : "f572d396fae9206628714fb2ce00f72e94f2258f", "MD5" : "b1946ac92492d2347c6235b4d2611184", "DropboxHash" : "ecb65bb98f9d905b70458986c39fcbad7715e5f2fcc3b1f07767d7c83e2438cc" }, "ID": "y2djkhiujf83u33", "OrigID": "UYOJVTUW00Q1RzTDA", "IsDir" : false, "MimeType" : "application/octet-stream", "ModTime" : "2017-05-31T16:15:57.034468261+01:00", "Name" : "file.txt", "Encrypted" : "v0qpsdq8anpci8n929v3uu9338", "Path" : "full/path/goes/here/file.txt", "Size" : 6 }</p>
<p>If --hash is not specified the Hashes property won't be emitted.</p>
<p>If --no-modtime is specified then ModTime will be blank.</p>
<p>If --encrypted is not specified the Encrypted won't be emitted.</p>
<p>The Path field will only show folders below the remote path being listed. If "remote:path" contains the file "subfolder/file.txt", the Path for "file.txt" will be "subfolder/file.txt", not "remote:path/subfolder/file.txt". When used without --recursive the Path will always be the same as Name.</p>
<p>The time is in RFC3339 format with nanosecond precision.</p>
<p>The whole output can be processed as a JSON blob, or alternatively it can be processed line by line as each item is written one to a line.</p>
<p>Any of the filtering options can be applied to this commmand.</p>
<p>There are several related list commands</p>
<ul>
<li><code>ls</code> to list size and path of objects only</li>
<li><code>lsl</code> to list modification time, size and path of objects only</li>
<li><code>lsd</code> to list directories only</li>
<li><code>lsf</code> to list objects and directories in easy to parse format</li>
<li><code>lsjson</code> to list objects and directories in JSON format</li>
</ul>
<p><code>ls</code>,<code>lsl</code>,<code>lsd</code> are designed to be human readable. <code>lsf</code> is designed to be human and machine readable. <code>lsjson</code> is designed to be machine readable.</p>
<p>Note that <code>ls</code> and <code>lsl</code> recurse by default - use "--max-depth 1" to stop the recursion.</p>
<p>The other list commands <code>lsd</code>,<code>lsf</code>,<code>lsjson</code> do not recurse by default - use "-R" to make them recurse.</p>
<p>Listing a non existent directory will produce an error except for remotes which can't have empty directories (eg s3, swift, gcs, etc - the bucket based remotes).</p>
<pre><code>rclone lsjson remote:path [flags]</code></pre>
<h3 id="options-45">Options</h3>
<pre><code> -M, --encrypted Show the encrypted names.
--hash Include hashes in the output (may take longer).
-h, --help help for lsjson
--no-modtime Don't read the modification time (can speed things up).
--original Show the ID of the underlying Object.
-R, --recursive Recurse into the listing.</code></pre>
<h2 id="rclone-mount">rclone mount</h2>
<p>Mount the remote as file system on a mountpoint.</p>
<h3 id="synopsis-46">Synopsis</h3>
<p>rclone mount allows Linux, FreeBSD, macOS and Windows to mount any of Rclone's cloud storage systems as a file system with FUSE.</p>
<p>First set up your remote using <code>rclone config</code>. Check it works with <code>rclone ls</code> etc.</p>
<p>Start the mount like this</p>
<pre><code>rclone mount remote:path/to/files /path/to/local/mount</code></pre>
<p>Or on Windows like this where X: is an unused drive letter</p>
<pre><code>rclone mount remote:path/to/files X:</code></pre>
<p>When the program ends, either via Ctrl+C or receiving a SIGINT or SIGTERM signal, the mount is automatically stopped.</p>
<p>The umount operation can fail, for example when the mountpoint is busy. When that happens, it is the user's responsibility to stop the mount manually with</p>
<pre><code># Linux
fusermount -u /path/to/local/mount
# OS X
umount /path/to/local/mount</code></pre>
<h3 id="installing-on-windows">Installing on Windows</h3>
<p>To run rclone mount on Windows, you will need to download and install <a href="http://www.secfs.net/winfsp/">WinFsp</a>.</p>
<p>WinFsp is an <a href="https://github.com/billziss-gh/winfsp">open source</a> Windows File System Proxy which makes it easy to write user space file systems for Windows. It provides a FUSE emulation layer which rclone uses combination with <a href="https://github.com/billziss-gh/cgofuse">cgofuse</a>. Both of these packages are by Bill Zissimopoulos who was very helpful during the implementation of rclone mount for Windows.</p>
<h4 id="windows-caveats">Windows caveats</h4>
<p>Note that drives created as Administrator are not visible by other accounts (including the account that was elevated as Administrator). So if you start a Windows drive from an Administrative Command Prompt and then try to access the same drive from Explorer (which does not run as Administrator), you will not be able to see the new drive.</p>
<p>The easiest way around this is to start the drive from a normal command prompt. It is also possible to start a drive from the SYSTEM account (using <a href="https://github.com/billziss-gh/winfsp/wiki/WinFsp-Service-Architecture">the WinFsp.Launcher infrastructure</a>) which creates drives accessible for everyone on the system or alternatively using <a href="https://nssm.cc/usage">the nssm service manager</a>.</p>
<h3 id="limitations">Limitations</h3>
<p>Without the use of "--vfs-cache-mode" this can only write files sequentially, it can only seek when reading. This means that many applications won't work with their files on an rclone mount without "--vfs-cache-mode writes" or "--vfs-cache-mode full". See the <a href="#file-caching">File Caching</a> section for more info.</p>
<p>The bucket based remotes (eg Swift, S3, Google Compute Storage, B2, Hubic) won't work from the root - you will need to specify a bucket, or a path within the bucket. So <code>swift:</code> won't work whereas <code>swift:bucket</code> will as will <code>swift:bucket/path</code>. None of these support the concept of directories, so empty directories will have a tendency to disappear once they fall out of the directory cache.</p>
<p>Only supported on Linux, FreeBSD, OS X and Windows at the moment.</p>
<h3 id="rclone-mount-vs-rclone-synccopy">rclone mount vs rclone sync/copy</h3>
<p>File systems expect things to be 100% reliable, whereas cloud storage systems are a long way from 100% reliable. The rclone sync/copy commands cope with this with lots of retries. However rclone mount can't use retries in the same way without making local copies of the uploads. Look at the <a href="#file-caching">file caching</a> for solutions to make mount mount more reliable.</p>
<h3 id="attribute-caching">Attribute caching</h3>
<p>You can use the flag --attr-timeout to set the time the kernel caches the attributes (size, modification time etc) for directory entries.</p>
<p>The default is "1s" which caches files just long enough to avoid too many callbacks to rclone from the kernel.</p>
<p>In theory 0s should be the correct value for filesystems which can change outside the control of the kernel. However this causes quite a few problems such as <a href="https://github.com/ncw/rclone/issues/2157">rclone using too much memory</a>, <a href="https://forum.rclone.org/t/rclone-1-39-vs-1-40-mount-issue/5112">rclone not serving files to samba</a> and <a href="https://github.com/ncw/rclone/issues/2095#issuecomment-371141147">excessive time listing directories</a>.</p>
<p>The kernel can cache the info about a file for the time given by "--attr-timeout". You may see corruption if the remote file changes length during this window. It will show up as either a truncated file or a file with garbage on the end. With "--attr-timeout 1s" this is very unlikely but not impossible. The higher you set "--attr-timeout" the more likely it is. The default setting of "1s" is the lowest setting which mitigates the problems above.</p>
<p>If you set it higher ('10s' or '1m' say) then the kernel will call back to rclone less often making it more efficient, however there is more chance of the corruption issue above.</p>
<p>If files don't change on the remote outside of the control of rclone then there is no chance of corruption.</p>
<p>This is the same as setting the attr_timeout option in mount.fuse.</p>
<h3 id="filters">Filters</h3>
<p>Note that all the rclone filters can be used to select a subset of the files to be visible in the mount.</p>
<h3 id="systemd">systemd</h3>
<p>When running rclone mount as a systemd service, it is possible to use Type=notify. In this case the service will enter the started state after the mountpoint has been successfully set up. Units having the rclone mount service specified as a requirement will see all files and folders immediately in this mode.</p>
<h3 id="chunked-reading">chunked reading</h3>
<p>--vfs-read-chunk-size will enable reading the source objects in parts. This can reduce the used download quota for some remotes by requesting only chunks from the remote that are actually read at the cost of an increased number of requests.</p>
<p>When --vfs-read-chunk-size-limit is also specified and greater than --vfs-read-chunk-size, the chunk size for each open file will get doubled for each chunk read, until the specified value is reached. A value of -1 will disable the limit and the chunk size will grow indefinitely.</p>
<p>With --vfs-read-chunk-size 100M and --vfs-read-chunk-size-limit 0 the following parts will be downloaded: 0-100M, 100M-200M, 200M-300M, 300M-400M and so on. When --vfs-read-chunk-size-limit 500M is specified, the result would be 0-100M, 100M-300M, 300M-700M, 700M-1200M, 1200M-1700M and so on.</p>
<p>Chunked reading will only work with --vfs-cache-mode < full, as the file will always be copied to the vfs cache before opening with --vfs-cache-mode full.</p>
<h3 id="directory-cache">Directory Cache</h3>
<p>Using the <code>--dir-cache-time</code> flag, you can set how long a directory should be considered up to date and not refreshed from the backend. Changes made locally in the mount may appear immediately or invalidate the cache. However, changes done on the remote will only be picked up once the cache expires.</p>
<p>Alternatively, you can send a <code>SIGHUP</code> signal to rclone for it to flush all directory caches, regardless of how old they are. Assuming only one rclone instance is running, you can reset the cache like this:</p>
<pre><code>kill -SIGHUP $(pidof rclone)</code></pre>
<p>If you configure rclone with a <a href="/rc">remote control</a> then you can use rclone rc to flush the whole directory cache:</p>
<pre><code>rclone rc vfs/forget</code></pre>
<p>Or individual files or directories:</p>
<pre><code>rclone rc vfs/forget file=path/to/file dir=path/to/dir</code></pre>
<h3 id="file-buffering">File Buffering</h3>
<p>The <code>--buffer-size</code> flag determines the amount of memory, that will be used to buffer data in advance.</p>
<p>Each open file descriptor will try to keep the specified amount of data in memory at all times. The buffered data is bound to one file descriptor and won't be shared between multiple open file descriptors of the same file.</p>
<p>This flag is a upper limit for the used memory per file descriptor. The buffer will only use memory for data that is downloaded but not not yet read. If the buffer is empty, only a small amount of memory will be used. The maximum memory used by rclone for buffering can be up to <code>--buffer-size * open files</code>.</p>
<h3 id="file-caching">File Caching</h3>
<p>These flags control the VFS file caching options. The VFS layer is used by rclone mount to make a cloud storage system work more like a normal file system.</p>
<p>You'll need to enable VFS caching if you want, for example, to read and write simultaneously to a file. See below for more details.</p>
<p>Note that the VFS cache works in addition to the cache backend and you may find that you need one or the other or both.</p>
<pre><code>--cache-dir string Directory rclone will use for caching.
--vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-mode string Cache mode off|minimal|writes|full (default "off")
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s)</code></pre>
<p>If run with <code>-vv</code> rclone will print the location of the file cache. The files are stored in the user cache file area which is OS dependent but can be controlled with <code>--cache-dir</code> or setting the appropriate environment variable.</p>
<p>The cache has 4 different modes selected by <code>--vfs-cache-mode</code>. The higher the cache mode the more compatible rclone becomes at the cost of using disk space.</p>
<p>Note that files are written back to the remote only when they are closed so if rclone is quit or dies with open files then these won't get written back to the remote. However they will still be in the on disk cache.</p>
<h4 id="vfs-cache-mode-off">--vfs-cache-mode off</h4>
<p>In this mode the cache will read directly from the remote and write directly to the remote without caching anything on disk.</p>
<p>This will mean some operations are not possible</p>
<ul>
<li>Files can't be opened for both read AND write</li>
<li>Files opened for write can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files open for read with O_TRUNC will be opened write only</li>
<li>Files open for write only will behave as if O_TRUNC was supplied</li>
<li>Open modes O_APPEND, O_TRUNC are ignored</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h4 id="vfs-cache-mode-minimal">--vfs-cache-mode minimal</h4>
<p>This is very similar to "off" except that files opened for read AND write will be buffered to disks. This means that files opened for write will be a lot more compatible, but uses the minimal disk space.</p>
<p>These operations are not possible</p>
<ul>
<li>Files opened for write only can't be seeked</li>
<li>Existing files opened for write must have O_TRUNC set</li>
<li>Files opened for write only will ignore O_APPEND, O_TRUNC</li>
<li>If an upload fails it can't be retried</li>
</ul>
<h4 id="vfs-cache-mode-writes">--vfs-cache-mode writes</h4>
<p>In this mode files opened for read only are still read directly from the remote, write only and read/write files are buffered to disk first.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload fails it will be retried up to --low-level-retries times.</p>
<h4 id="vfs-cache-mode-full">--vfs-cache-mode full</h4>
<p>In this mode all reads and writes are buffered to and from disk. When a file is opened for read it will be downloaded in its entirety first.</p>
<p>This may be appropriate for your needs, or you may prefer to look at the cache backend which does a much more sophisticated job of caching, including caching directory hierarchies and chunks of files.</p>
<p>In this mode, unlike the others, when a file is written to the disk, it will be kept on the disk after it is written to the remote. It will be purged on a schedule according to <code>--vfs-cache-max-age</code>.</p>
<p>This mode should support all normal file system operations.</p>
<p>If an upload or download fails it will be retried up to --low-level-retries times.</p>
<pre><code>rclone mount remote:path /path/to/mountpoint [flags]</code></pre>
<h3 id="options-46">Options</h3>
<pre><code> --allow-non-empty Allow mounting over a non-empty directory.
--allow-other Allow access to other users.
--allow-root Allow access to root user.
--attr-timeout duration Time for which file/directory attributes are cached. (default 1s)
--daemon Run mount as a daemon (background mode).
--daemon-timeout duration Time limit for rclone to respond to kernel (not supported by all OSes).
--debug-fuse Debug the FUSE internals - needs -v.
--default-permissions Makes kernel enforce access control based on the file mode.
--dir-cache-time duration Time to cache directory entries for. (default 5m0s)
--fuse-flag stringArray Flags or arguments to be passed direct to libfuse/WinFsp. Repeat if required.
--gid uint32 Override the gid field set by the filesystem. (default 502)
-h, --help help for mount
--max-read-ahead int The number of bytes that can be prefetched for sequential reads. (default 128k)
--no-checksum Don't compare checksums on up/download.
--no-modtime Don't read/write the modification time (can speed things up).
--no-seek Don't allow seeking in files.
-o, --option stringArray Option for libfuse/WinFsp. Repeat if required.
--poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s)
--read-only Mount read-only.