github.com/ncw/rclone@v1.48.1-0.20190724201158-a35aa1360e3e/docs/content/alias.md (about) 1 --- 2 title: "Alias" 3 description: "Remote Aliases" 4 date: "2018-01-30" 5 --- 6 7 <i class="fa fa-link"></i> Alias 8 ----------------------------------------- 9 10 The `alias` remote provides a new name for another remote. 11 12 Paths may be as deep as required or a local path, 13 eg `remote:directory/subdirectory` or `/directory/subdirectory`. 14 15 During the initial setup with `rclone config` you will specify the target 16 remote. The target remote can either be a local path or another remote. 17 18 Subfolders can be used in target remote. Assume a alias remote named `backup` 19 with the target `mydrive:private/backup`. Invoking `rclone mkdir backup:desktop` 20 is exactly the same as invoking `rclone mkdir mydrive:private/backup/desktop`. 21 22 There will be no special handling of paths containing `..` segments. 23 Invoking `rclone mkdir backup:../desktop` is exactly the same as invoking 24 `rclone mkdir mydrive:private/backup/../desktop`. 25 The empty path is not allowed as a remote. To alias the current directory 26 use `.` instead. 27 28 Here is an example of how to make a alias called `remote` for local folder. 29 First run: 30 31 rclone config 32 33 This will guide you through an interactive setup process: 34 35 ``` 36 No remotes found - make a new one 37 n) New remote 38 s) Set configuration password 39 q) Quit config 40 n/s/q> n 41 name> remote 42 Type of storage to configure. 43 Choose a number from below, or type in your own value 44 1 / Alias for an existing remote 45 \ "alias" 46 2 / Amazon Drive 47 \ "amazon cloud drive" 48 3 / Amazon S3 (also Dreamhost, Ceph, Minio) 49 \ "s3" 50 4 / Backblaze B2 51 \ "b2" 52 5 / Box 53 \ "box" 54 6 / Cache a remote 55 \ "cache" 56 7 / Dropbox 57 \ "dropbox" 58 8 / Encrypt/Decrypt a remote 59 \ "crypt" 60 9 / FTP Connection 61 \ "ftp" 62 10 / Google Cloud Storage (this is not Google Drive) 63 \ "google cloud storage" 64 11 / Google Drive 65 \ "drive" 66 12 / Hubic 67 \ "hubic" 68 13 / Local Disk 69 \ "local" 70 14 / Microsoft Azure Blob Storage 71 \ "azureblob" 72 15 / Microsoft OneDrive 73 \ "onedrive" 74 16 / Openstack Swift (Rackspace Cloud Files, Memset Memstore, OVH) 75 \ "swift" 76 17 / Pcloud 77 \ "pcloud" 78 18 / QingCloud Object Storage 79 \ "qingstor" 80 19 / SSH/SFTP Connection 81 \ "sftp" 82 20 / Webdav 83 \ "webdav" 84 21 / Yandex Disk 85 \ "yandex" 86 22 / http Connection 87 \ "http" 88 Storage> 1 89 Remote or path to alias. 90 Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path". 91 remote> /mnt/storage/backup 92 Remote config 93 -------------------- 94 [remote] 95 remote = /mnt/storage/backup 96 -------------------- 97 y) Yes this is OK 98 e) Edit this remote 99 d) Delete this remote 100 y/e/d> y 101 Current remotes: 102 103 Name Type 104 ==== ==== 105 remote alias 106 107 e) Edit existing remote 108 n) New remote 109 d) Delete remote 110 r) Rename remote 111 c) Copy remote 112 s) Set configuration password 113 q) Quit config 114 e/n/d/r/c/s/q> q 115 ``` 116 117 Once configured you can then use `rclone` like this, 118 119 List directories in top level in `/mnt/storage/backup` 120 121 rclone lsd remote: 122 123 List all the files in `/mnt/storage/backup` 124 125 rclone ls remote: 126 127 Copy another local directory to the alias directory called source 128 129 rclone copy /home/source remote:source 130 131 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/alias/alias.go then run make backenddocs --> 132 ### Standard Options 133 134 Here are the standard options specific to alias (Alias for an existing remote). 135 136 #### --alias-remote 137 138 Remote or path to alias. 139 Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path". 140 141 - Config: remote 142 - Env Var: RCLONE_ALIAS_REMOTE 143 - Type: string 144 - Default: "" 145 146 <!--- autogenerated options stop -->