How to connect rclone to Tarkle (beta)
Beta steps to connect rclone to Tarkle: build the fork, create an API key and copy your first files.
rclone is the command-line tool for copying and syncing files across cloud storage. You can connect Tarkle to rclone with the steps below.
Beta: the Tarkle support for rclone is not in any official rclone release yet. A normal rclone install does not show Tarkle. You build rclone from Tarkle's fork instead, on the branch that holds the Tarkle support. This is for people comfortable with Go and a terminal.
Build rclone with the Tarkle support
Go 1.26 is needed to build the fork.
Clone the fork and open it:
git clone https://github.com/tarkleHQ/rclone, thencd rclone.Switch to the branch that holds the Tarkle support:
git checkout tarkle-backend.Build the binary:
go build -o rclone-tarkle .. The steps below use./rclone-tarkle, not the rclone you installed before.
Connect rclone to your workspace
Create an API key. Open API in Settings and stay on the API keys tab. Only owners and admins of your organization see this page. Members ask one of them for a key, as explained in Teams, roles and sharing files with your team. Click Create, type a Name, and under Access choose All workspaces or Only selected workspaces. Click Create, then click the key under Token to copy it. The key can be copied again later from the row menu, with Copy token. For the details, read How to create and manage an API key.
Find the workspace key. Open the workspace in Tarkle. The eight characters that follow
/dashboard/in the address are the workspace key.Run the setup. Run
./rclone-tarkle config, type n for a new remote, and name ittarkle. At the storage prompt, typetarkle. Then answer the prompts:
token: paste the key from step 1. rclone stores it in its config file in obscured form.
workspace: paste the workspace key from step 2. This is required, because one key can reach several workspaces.
Answer n to Edit advanced config?, then confirm the remote with y.
Test the connection. Run
./rclone-tarkle lsf tarkle:. It lists the top level of your Tarkle library in that workspace.Make a first copy. Run
./rclone-tarkle copy /path/to/folder tarkle:test, then./rclone-tarkle check /path/to/folder tarkle:testto compare the two sides.
Note: if you leave workspace blank, rclone does not pick one for you. The first command that uses the remote lists the workspace keys and names and stops, so you can edit the remote and enter one.
What happens next
The folder you copied appears in the workspace's library. Use the same remote for rclone sync and rclone check in your own scripts.
Tips
rclone syncandrclone checkwork without--size-only. Tarkle stores the modification time, to the second, and a SHA-256 for each file.rclone overwrites a file with the same name. On plans that keep file versions, the new content becomes a new version of the file.
Tarkle allows 600 file requests a minute for each key. If you see 429 errors, lower
--transfersand--checkers, or add--tpslimit.Deleting a file that is part of an active transfer is refused. Add
--tarkle-delete-transfersto delete that transfer too. Feedback boards and paid transfers with purchases can never be deleted through the API.A key with the Legacy badge keeps its older, limited permissions. Create a new key for rclone.
Many small files upload more slowly than a few large ones, because each file takes several requests.
When rclone reports an error
401 unauthorized: the key is mistyped, or it was deleted. Check the key, or create a new one.
401 legacy_token: the key is a retired workspace token and no longer works. Create a new key in Settings, API.
403 no_access: the workspace key is wrong, or the key cannot reach that workspace.
413 file_too_large: the file is bigger than your plan's largest-file limit.
413 storage_limit_exceeded: the workspace is full.
Delete a key with Delete in its row menu to stop rclone at once.