github.com/10XDev/rclone@v1.52.3-0.20200626220027-16af9ab76b2a/docs/content/alias.md (about)

     1  ---
     2  title: "Alias"
     3  description: "Remote Aliases"
     4  ---
     5  
     6  {{< icon "fa fa-link" >}} Alias
     7  -----------------------------------------
     8  
     9  The `alias` remote provides a new name for another remote.
    10  
    11  Paths may be as deep as required or a local path, 
    12  eg `remote:directory/subdirectory` or `/directory/subdirectory`.
    13  
    14  During the initial setup with `rclone config` you will specify the target
    15  remote. The target remote can either be a local path or another remote.
    16  
    17  Subfolders can be used in target remote. Assume an alias remote named `backup`
    18  with the target `mydrive:private/backup`. Invoking `rclone mkdir backup:desktop`
    19  is exactly the same as invoking `rclone mkdir mydrive:private/backup/desktop`.
    20  
    21  There will be no special handling of paths containing `..` segments.
    22  Invoking `rclone mkdir backup:../desktop` is exactly the same as invoking
    23  `rclone mkdir mydrive:private/backup/../desktop`.
    24  The empty path is not allowed as a remote. To alias the current directory
    25  use `.` instead.
    26  
    27  Here is an example of how to make an alias called `remote` for local folder.
    28  First run:
    29  
    30       rclone config
    31  
    32  This will guide you through an interactive setup process:
    33  
    34  ```
    35  No remotes found - make a new one
    36  n) New remote
    37  s) Set configuration password
    38  q) Quit config
    39  n/s/q> n
    40  name> remote
    41  Type of storage to configure.
    42  Choose a number from below, or type in your own value
    43  [snip]
    44  XX / Alias for an existing remote
    45     \ "alias"
    46  [snip]
    47  Storage> alias
    48  Remote or path to alias.
    49  Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path".
    50  remote> /mnt/storage/backup
    51  Remote config
    52  --------------------
    53  [remote]
    54  remote = /mnt/storage/backup
    55  --------------------
    56  y) Yes this is OK
    57  e) Edit this remote
    58  d) Delete this remote
    59  y/e/d> y
    60  Current remotes:
    61  
    62  Name                 Type
    63  ====                 ====
    64  remote               alias
    65  
    66  e) Edit existing remote
    67  n) New remote
    68  d) Delete remote
    69  r) Rename remote
    70  c) Copy remote
    71  s) Set configuration password
    72  q) Quit config
    73  e/n/d/r/c/s/q> q
    74  ```
    75  
    76  Once configured you can then use `rclone` like this,
    77  
    78  List directories in top level in `/mnt/storage/backup`
    79  
    80      rclone lsd remote:
    81  
    82  List all the files in `/mnt/storage/backup`
    83  
    84      rclone ls remote:
    85  
    86  Copy another local directory to the alias directory called source
    87  
    88      rclone copy /home/source remote:source
    89  
    90  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/alias/alias.go then run make backenddocs" >}}
    91  ### Standard Options
    92  
    93  Here are the standard options specific to alias (Alias for an existing remote).
    94  
    95  #### --alias-remote
    96  
    97  Remote or path to alias.
    98  Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path".
    99  
   100  - Config:      remote
   101  - Env Var:     RCLONE_ALIAS_REMOTE
   102  - Type:        string
   103  - Default:     ""
   104  
   105  {{< rem autogenerated options stop >}}