clonetree

A copy‑on‑write directory library for Rust

clonetree is a Rust crate for fast directory duplication. It uses filesystem‑level reflinks so large trees are cloned quickly and consume no extra space until files diverge.

Highlights

• Fast copy‑on‑write clone on APFS, Btrfs, XFS, bcachefs, overlayfs, ReFS…

• Powered by reflink-copy for portable block‑cloning.

• Flexible glob patterns to include/exclude files (uses ! prefix for exclusions).

• Graceful fallback to std::fs::copy when reflinks are unsupported.

• Pure Rust, no unsafe code, minimal deps.

Library quick start

Clone only Rust source files under src/ into ./sandbox, while excluding unit tests. This demonstrates the precedence rules from the ignore crate: later patterns override earlier ones.

use clonetree::{clone_tree, Options};

fn main() -> anyhow::Result<()> {
    // Include all source files but drop tests
    let opts = Options::new()
        .glob("src/**")         // positive include
        .glob("!src/tests/**"); // negative exclude; overrides the line above

    clone_tree("./", "./sandbox", &opts)?;
    Ok(())
}

Glob syntax

clonetree accepts the same glob rules as a single line in a .gitignore file. Prefix a pattern with ! to exclude matching paths instead of including them.

Rules:

• * matches any sequence of characters except path separators.
• ** matches across directory boundaries.
• ? matches exactly one character.
• A trailing / restricts the pattern to directories only.
• Patterns are evaluated in the order they are given; later patterns can override earlier ones (precedence follows the ignore crate).

ctree ‑ command‑line tool

The crate ships with a convenience binary so users can benefit without writing code.

Install

cargo install ctree

Semantics

ctree copies a directory to a specified destination. The source must be a directory, and the destination must not exist.

Basic usage

ctree <SRC> <DEST> [OPTIONS]

OPTIONS:
  -g, --glob <GLOB>      Match or exclude glob (repeatable)
      --no-reflink       Disable reflink, perform a regular copy
  -q, --quiet            Suppress progress output
  -h, --help             Show this help

Example: snapshot a repo while excluding Git metadata and build output:

ctree . ./sandbox \
  --glob '!target/**' \
  --glob '!.git/**'

Filesystem support matrix

Via reflink-copy