rclone --include-from
Include-from uses rule files to define a deterministic allow-list that can be shared across scripts and environments. This guide emphasizes repeatable selection patterns so only approved file classes move during scheduled jobs or release pipelines.
Syntax
rclone copy SRC DST --include-from /path/to/include.rules
Rule File Example
/etc/rclone/docs.include
**/*.md
**/*.mdx
**/*.pdf
rclone copy /srv/docs remote:backup/docs --include-from /etc/rclone/docs.include
Notes
- Use this for deterministic, auditable selections.
- Keep rules small and purposeful.
- Always dry-run before replacing production jobs.
rclone copy /srv/docs remote:backup/docs --include-from /etc/rclone/docs.include --dry-run -vv
Examples with Output
1. Use include file for docs
Input command:
rclone copy /srv/docs remote:backup/docs --include-from /etc/rclone/docs.include --dry-run
Expected output:
NOTICE: include file loaded
Would transfer 53 files
2. Include-from markdown only
Input command:
rclone copy /srv/wiki remote:backup/wiki --include-from /etc/rclone/wiki.include --dry-run
Expected output:
NOTICE: allow-list patterns matched
Would transfer 31 files
3. Include-from for release assets
Input command:
rclone copy /srv/releases remote:archive/releases --include-from /etc/rclone/release.include --dry-run
Expected output:
NOTICE: release artifacts selected
Would transfer 14 files
4. Include-from with verbose
Input command:
rclone copy /srv/docs remote:backup/docs --include-from /etc/rclone/docs.include --dry-run -vv
Expected output:
DEBUG: Included by rule file: handbook/index.mdx
INFO : 53 files marked for transfer
5. Include-from for db dumps
Input command:
rclone copy /srv/backups remote:archive/db --include-from /etc/rclone/db.include --dry-run
Expected output:
NOTICE: database dump rules applied
Would transfer 11 files
6. Include-from with checkers/transfers
Input command:
rclone copy /srv/docs remote:backup/docs --include-from /etc/rclone/docs.include --checkers 8 --transfers 4 --dry-run
Expected output:
NOTICE: checkers=8 transfers=4
Would transfer 53 files
7. Include-from with size cap
Input command:
rclone copy /srv/data remote:backup/data --include-from /etc/rclone/data.include --max-size 100M --dry-run
Expected output:
NOTICE: max-size filter active
Would transfer 42 files
8. Include-from for source code only
Input command:
rclone copy /srv/app remote:backup/app --include-from /etc/rclone/source.include --dry-run
Expected output:
NOTICE: source code rules selected
Would transfer 127 files
9. Include-from with compare destination
Input command:
rclone sync /srv/docs remote:backup/docs --include-from /etc/rclone/docs.include --dry-run
Expected output:
NOTICE: sync preview with include-from
Would delete 0 files, copy 53 files
10. Include-from for compliance export
Input command:
rclone copy /srv/audit remote:archive/audit --include-from /etc/rclone/audit.include --dry-run
Expected output:
NOTICE: compliance documents selected
Would transfer 66 files
11. Include-from for images
Input command:
rclone copy /srv/media remote:backup/media --include-from /etc/rclone/image.include --dry-run
Expected output:
NOTICE: image extensions matched
Would transfer 289 files
12. Include-from with immutable
Input command:
rclone copy /srv/releases remote:archive/releases --include-from /etc/rclone/release.include --immutable --dry-run
Expected output:
NOTICE: immutable mode active
Would transfer 14 files
13. Include-from with update-only
Input command:
rclone copy /srv/docs remote:backup/docs --include-from /etc/rclone/docs.include --update --dry-run
Expected output:
NOTICE: update-only enabled
Would transfer 9 newer files
14. Include-from with backup-dir
Input command:
rclone sync /srv/docs remote:backup/docs --include-from /etc/rclone/docs.include --backup-dir remote:backup/docs-deleted --dry-run
Expected output:
NOTICE: backup-dir configured
Would copy 53 files, move 2 deletes
15. Include-from + checksum
Input command:
rclone copy /srv/docs remote:backup/docs --include-from /etc/rclone/docs.include --checksum --dry-run
Expected output:
NOTICE: checksum mode active
Would transfer 17 changed files