mcpField
R
rclone

rclone

github.com/everyincCloud & DevOps25.8k452 installsUpdated today
Repository

About rclone

rclone is a skill that guides agents through using rclone to transfer files between local paths and remote storage. It covers setup checks, common copy and sync operations, transfer verification, and troubleshooting.

Key features

  1. 01Checks installation and remote configuration
  2. 02Guides cloud remote setup
  3. 03Copies, syncs, and lists files
  4. 04Previews transfers and verifies results
  5. 05Covers large files and troubleshooting

Use cases

  1. 01Setting up rclone remotes
  2. 02Uploading a file or directory
  3. 03Previewing or syncing directory contents
  4. 04Troubleshooting transfers and checking files

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/everyinc/compound-engineering-plugin --skill rclone

After installing, type/rclonein Claude Code to confirm it loaded.

Bundled filesscripts/check_setup.sh

Details

From the project README

rclone File Transfer Skill

Setup Check (Always Run First)

Before any rclone operation, verify installation and configuration:

# Check if rclone is installed
command -v rclone >/dev/null 2>&1 && echo "rclone installed: $(rclone version | head -1)" || echo "NOT INSTALLED"

# List configured remotes
rclone listremotes 2>/dev/null || echo "NO REMOTES CONFIGURED"
If rclone is NOT installed

Guide the user to install:

# macOS
brew install rclone

# Linux (script install)
curl https://rclone.org/install.sh | sudo bash

# Or via package manager
sudo apt install rclone  # Debian/Ubuntu
sudo dnf install rclone  # Fedora
If NO remotes are configured

Walk the user through interactive configuration:

rclone config

Common provider setup quick reference:

ProviderTypeKey Settings
AWS S3s3access_key_id, secret_access_key, region
Cloudflare R2s3access_key_id, secret_access_key, endpoint (account_id.r2.cloudflarestorage.com)
Backblaze B2b2account (keyID), key (applicationKey)
DigitalOcean Spacess3access_key_id, secret_access_key, endpoint (region.digitaloceanspaces.com)
Google DrivedriveOAuth flow (opens browser)
DropboxdropboxOAuth flow (opens browser)

Example: Configure Cloudflare R2

rclone config create r2 s3 \
  provider=Cloudflare \
  access_key_id=YOUR_ACCESS_KEY \
  secret_access_key=YOUR_SECRET_KEY \
  endpoint=ACCOUNT_ID.r2.cloudflarestorage.com \
  acl=private

Example: Configure AWS S3

rclone config create aws s3 \
  provider=AWS \
  access_key_id=YOUR_ACCESS_KEY \
  secret_access_key=YOUR_SECRET_KEY \
  region=us-east-1

Common Operations

Upload single file
rclone copy /path/to/file.mp4 remote:bucket/path/ --progress
Upload directory
rclone copy /path/to/folder remote:bucket/folder/ --progress
Sync directory (mirror, deletes removed files)
rclone sync /local/path remote:bucket/path/ --progress
List remote contents
rclone ls remote:bucket/
rclone lsd remote:bucket/  # directories only
Check what would be transferred (dry run)
rclone copy /path remote:bucket/ --dry-run

Useful Flags

FlagPurpose
--progressShow transfer progress
--dry-runPreview without transferring
-vVerbose output
--transfers=NParallel transfers (default 4)
--bwlimit=RATEBandwidth limit (e.g., 10M)
--checksumCompare by checksum, not size/time
--exclude="*.tmp"Exclude patterns
--include="*.mp4"Include only matching
--min-size=SIZESkip files smaller than SIZE
--max-size=SIZESkip files larger than SIZE

Large File Uploads

For videos and large files, use chunked uploads:

# S3 multipart upload (automatic for >200MB)
rclone copy large_video.mp4 remote:bucket/ --s3-chunk-size=64M --progress

# Resume interrupted transfers
rclone copy /path remote:bucket/ --progress --retries=5

Verify Upload

# Check file exists and matches
rclone check /local/file remote:bucket/file

# Get file info
rclone lsl remote:bucket/path/to/file

Troubleshooting

# Test connection
rclone lsd remote:

# Debug connection issues
rclone lsd remote: -vv

# Check config
rclone config show remote

Comments

Markdown supported