github.com/artpar/rclone@v1.67.3/docs/content/alias.md (about)

     1  ---
     2  title: "Alias"
     3  description: "Remote Aliases"
     4  versionIntroduced: "v1.40"
     5  ---
     6  
     7  # {{< icon "fa fa-link" >}} Alias
     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  e.g. `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  The target remote can also be a [connection string](/docs/#connection-strings). 
    28  This can be used to modify the config of a remote for different uses, e.g.
    29  the alias  `myDriveTrash` with the target remote `myDrive,trashed_only:` 
    30  can be used to only show the trashed files in `myDrive`.
    31  
    32  ## Configuration
    33  
    34  Here is an example of how to make an alias called `remote` for local folder.
    35  First run:
    36  
    37       rclone config
    38  
    39  This will guide you through an interactive setup process:
    40  
    41  ```
    42  No remotes found, make a new one?
    43  n) New remote
    44  s) Set configuration password
    45  q) Quit config
    46  n/s/q> n
    47  name> remote
    48  Type of storage to configure.
    49  Choose a number from below, or type in your own value
    50  [snip]
    51  XX / Alias for an existing remote
    52     \ "alias"
    53  [snip]
    54  Storage> alias
    55  Remote or path to alias.
    56  Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path".
    57  remote> /mnt/storage/backup
    58  Remote config
    59  --------------------
    60  [remote]
    61  remote = /mnt/storage/backup
    62  --------------------
    63  y) Yes this is OK
    64  e) Edit this remote
    65  d) Delete this remote
    66  y/e/d> y
    67  Current remotes:
    68  
    69  Name                 Type
    70  ====                 ====
    71  remote               alias
    72  
    73  e) Edit existing remote
    74  n) New remote
    75  d) Delete remote
    76  r) Rename remote
    77  c) Copy remote
    78  s) Set configuration password
    79  q) Quit config
    80  e/n/d/r/c/s/q> q
    81  ```
    82  
    83  Once configured you can then use `rclone` like this,
    84  
    85  List directories in top level in `/mnt/storage/backup`
    86  
    87      rclone lsd remote:
    88  
    89  List all the files in `/mnt/storage/backup`
    90  
    91      rclone ls remote:
    92  
    93  Copy another local directory to the alias directory called source
    94  
    95      rclone copy /home/source remote:source
    96  
    97  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/alias/alias.go then run make backenddocs" >}}
    98  ### Standard options
    99  
   100  Here are the Standard options specific to alias (Alias for an existing remote).
   101  
   102  #### --alias-remote
   103  
   104  Remote or path to alias.
   105  
   106  Can be "myremote:path/to/dir", "myremote:bucket", "myremote:" or "/local/path".
   107  
   108  Properties:
   109  
   110  - Config:      remote
   111  - Env Var:     RCLONE_ALIAS_REMOTE
   112  - Type:        string
   113  - Required:    true
   114  
   115  ### Advanced options
   116  
   117  Here are the Advanced options specific to alias (Alias for an existing remote).
   118  
   119  #### --alias-description
   120  
   121  Description of the remote
   122  
   123  Properties:
   124  
   125  - Config:      description
   126  - Env Var:     RCLONE_ALIAS_DESCRIPTION
   127  - Type:        string
   128  - Required:    false
   129  
   130  {{< rem autogenerated options stop >}}