This is a 'Getting Starting' tutorial that will showcase the process for configuring Rclone with Tardigrade. We will cover only some of the basic features in this guide.
For making the most of Rclone, take a look at the complete Rclone command reference
You will need one of the following:
Access Grant that someone else shared with you, or
API Key of a Tardigrade project you are a member of.
First, Download and extract the rclone binary onto your system.
Execute the config command:
A text-based menu will prompt. Type
n and hit
Enter to create a new remote configuration.
Enter a name for the new remote configuration, e.g.
A long list of supported storage backends will prompt. Enter
tardigrade and hit
Choose your authentication method: existing access grant or new access grant from API key.
If you selected to authenticate with an existing access grant, enter the serialized access grant you have received by someone else.
If you selected to authenticate with a new access grant, first enter the satellite address by selecting one from the list or enter the address of a 3rd-party satellite.
The second step of creating a new access grant is to enter your API key.
The final step of creating a new access grant is to enter your encryption passphrase.
A summary of the remote configuration will prompt. Type
Enter to confirm it.
Now you should see one remote configuration available. Enter
q and hit
Enter to quit the configuration wizard.
mkdir command to create new bucket, e.g.
rclone mkdir waterbear:mybucket
lsf command to list all buckets.
rclone lsf waterbear:
rmdir command to delete an empty bucket.
rclone rmdir waterbear:mybucket
purge command to delete a non-empty bucket with all its content.
rclone purge waterbear:mybucket
copy command to upload an object.
rclone copy --progress ~/Videos/myvideo.mp4 waterbear:mybucket/videos/
Use a folder in the local path to upload all its objects.
rclone copy --progress ~/Videos/ waterbear:mybucket/videos/
ls command to list recursively all objects in a bucket.
rclone ls waterbear:mybucket
Add the folder to the remote path to list recursively all objects in this folder.
rclone ls waterbear:mybucket/videos/
lsf command to list non-recursively all objects in a bucket or a folder.
rclone lsf water:mybucket/videos/
copy command to download an object.
rclone copy --progress waterbear:mybucket/videos/myvideo.mp4 ~/Downloads/
Use a folder in the remote path to download all its objects.
rclone copy --progress waterbear:mybucket/videos/ ~/Downloads/
deletefile command to delete a single object.
rclone deletefile waterbear:mybucket/videos/myvideo.mp4
delete command to delete all object in a folder.
rclone delete waterbear:mybucket/videos/
size command to print the total size of objects in a bucket or a folder.
rclone size waterbear:mybucket/videos/
sync command to 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.
rclone sync --progress ~/Videos/ waterbear:mybucket/videos/
The sync can be done also from Tardigrade to the local file system.
rclone sync --progress waterbear:mybucket/videos/ ~/Videos/
Or between two Tardigrade buckets.
rclone sync --progress waterbear-us:mybucket/videos/ waterbear-europe:mybucket/videos/
Or even between another cloud storage and Tardigrade.
rclone sync --progress s3:mybucket/videos/ waterbear:mybucket/videos/