Skip to content

capture-file

Captures files by copying them, moving them, or computing their hash.

Use Cases

  • Preserve input configurations
  • Archive output results
  • Verify file integrity without copying large files
  • Organize experiment artifacts

Configuration

Required Options

Option Type Description
glob string File pattern to match (e.g., "*.txt", "results/**/*.png")

Optional Options

Option Type Default Description
mode string "copy" How to handle files: "copy", "move", or "none"
hash string "sha256" Hash algorithm: "sha256" or "none"

Mode Options

  • "copy" - Copies files to the hook's artifact directory, leaves originals
  • "move" - Moves files to the hook's artifact directory, removes originals
  • "none" - Only computes hash, doesn't copy or move

Per-hook artifact directory

When mode is "copy" or "move", files are placed in a per-hook artifact directory named {phase}-{index}-capture-file/ under the run directory (e.g., post-0-capture-file/). This prevents filename collisions between different capture-file hooks.

Example

[[post-run.hooks]]
id = "capture-file"
glob = "results/*.csv"
mode = "copy"
hash = "sha256"

Output Example

{
  "__meta": {
    "id": "capture-file",
    "config": {
      "glob": "results/*.csv",
      "mode": "copy",
      "hash": "sha256"
    },
    "success": true
  },
  "files": [
    {
      "src": "results/data.csv",
      "dst": ".capsula/my-vault/2025-01-09/143022-happy-river/post-0-capture-file/data.csv",
      "hash": "a1b2c3d4e5f6...",
      "copied": true
    },
    {
      "src": "results/summary.csv",
      "dst": ".capsula/my-vault/2025-01-09/143022-happy-river/post-0-capture-file/summary.csv",
      "hash": "b2c3d4e5f6g7...",
      "copied": true
    }
  ]
}