github.com/artpar/rclone@v1.67.3/cmd/gitannex/gitannex.md (about)

     1  Rclone's gitannex subcommand enables git-annex to store and retrieve content
     2  from an rclone remote. It expects to be run by git-annex, not directly by users.
     3  It is an "external special remote program" as defined by git-annex.
     4  
     5  Installation on Linux
     6  ---------------------
     7  
     8  1. Create a symlink and ensure it's on your PATH. For example:
     9  
    10          ln -s "$(realpath rclone)" "$HOME/bin/git-annex-remote-rclone-builtin"
    11  
    12  2. Add a new external remote to your git-annex repo.
    13  
    14     The new remote's type should be "rclone-builtin". When git-annex interacts
    15     with remotes of this type, it will try to run a command named
    16     "git-annex-remote-rclone-builtin", so the symlink from the previous step
    17     should be on your PATH.
    18  
    19     The following example creates a new git-annex remote named "MyRemote" that
    20     will use the rclone remote named "SomeRcloneRemote". This rclone remote must
    21     be configured in your rclone.conf file, wherever that is located on your
    22     system. The rcloneprefix value ensures that content is only written into the
    23     rclone remote underneath the "git-annex-content" directory.
    24  
    25          git annex initremote MyRemote         \
    26              type=external                     \
    27              externaltype=rclone-builtin       \
    28              encryption=none                   \
    29              rcloneremotename=SomeRcloneRemote \
    30              rcloneprefix=git-annex-content
    31  
    32  3. Before you trust this command with your precious data, be sure to **test the
    33     remote**. This command is very new and has not been tested on many rclone
    34     backends. Caveat emptor!
    35  
    36          git annex testremote my-rclone-remote
    37  
    38  Happy annexing!