Go to file
sneak d848c5e51b Remove dead code in symlink handling
filepath.Walk uses Lstat, so symlinks are reported with ModeSymlink set,
never ModeDir. The info.IsDir() check was always false, making the
filepath.SkipDir branch unreachable dead code.
2026-02-02 13:15:39 -08:00
.gitignore initial 2025-05-08 13:26:05 -07:00
attrsum_test.go Add quiet mode, progress bar, summary report, and stdin support 2026-02-01 04:22:13 -08:00
attrsum.go Remove dead code in symlink handling 2026-02-02 13:15:39 -08:00
go.mod Add quiet mode, progress bar, summary report, and stdin support 2026-02-01 04:22:13 -08:00
go.sum Add quiet mode, progress bar, summary report, and stdin support 2026-02-01 04:22:13 -08:00
Makefile seems to work, tests pass. woo! 2025-05-08 13:59:35 -07:00
README.md Add quiet mode, progress bar, summary report, and stdin support 2026-02-01 04:22:13 -08:00

attrsum is a Go 1.22 command-line utility that adds, updates, verifies, and clears per-file file content checksums stored in extended attributes (xattrs) on macOS (APFS) and Linux, released under the WTFPL v2.

Original release 2025-05-08.

Current version 1.0 (2025-05-08).


Getting Started — Quick Build

# prerequisites: Go 1.22+
git clone https://git.eeqj.de/sneak/attrsum.git
cd attrsum
go build -o attrsum .

Install

go install git.eeqj.de/sneak/attrsum@latest   # into GOPATH/bin or $(go env GOBIN)

Semantic Versioning 2.0.0 is used for tags.


Usage

# add checksum & timestamp xattrs to every regular file under one or more paths
attrsum sum add DIR1 DIR2 file.txt

# update checksum only when file mtime is newer than stored sumtime
attrsum sum update DIR1 DIR2

# verify checksums, stop on first error
attrsum check DIR1 DIR2

# verify every file, reporting each result, keep going after errors
attrsum -v check --continue DIR1 DIR2

# remove checksum & timestamp xattrs
attrsum clear DIR1 DIR2

# read paths from stdin (use - as argument)
find /data -name "*.jpg" | attrsum sum add -

# quiet mode (suppress progress bar and summary)
attrsum -q sum add DIR
xattr key meaning
berlin.sneak.app.attrsum.checksum base-58 multihash (sha2-256)
berlin.sneak.app.attrsum.sumtime RFC 3339 timestamp of checksum

Flags:

  • -v, --verbose — per-file log output
  • -q, --quiet — suppress all output except errors (no progress bar or summary)
  • --exclude PATTERN — skip paths matching rsync/Doublestar glob
  • --exclude-dotfiles — skip any path component that starts with .

All commands display a progress bar with ETA and print a summary report to stderr on completion (unless --quiet is specified).

attrsum never follows symlinks and skips non-regular files (sockets, devices, …).


Why?

Apple APFS and Linux ext3/ext4 store no per-file content checksums, so silent data corruption can pass unnoticed. attrsum keeps a portable checksum inside each files xattrs, providing integrity verification that travels with the file itself—no external database required. Now you can trust a USB stick didn't eat your data.


TODO

Future improvements under consideration:

  • Dry-run mode (--dry-run, -n) — show what would be done without making changes
  • JSON output (--json) — machine-readable output for scripting and integration
  • Parallel processing (-j N) — use multiple goroutines for faster checksumming on large trees
  • Exit code documentation — formalize and document exit codes for scripting

Contributing


Community & Support

Bug tracker and wiki are in the Gitea repo linked above.

No formal Code of Conduct; be excellent to each other.


License

Everything is permitted. See WTFPL v2.