Skip to content

Latest commit

 

History

History
119 lines (82 loc) · 3.9 KB

README.md

File metadata and controls

119 lines (82 loc) · 3.9 KB
Raw

fsdiff

fsdiff is a simple tool that helps to find out what changes occurred in a filesystem tree.

Using fsdiff involves two steps: first take a snapshot of the target filesystem before modifications happen, then another one after. Then, the diff step compares the two snapshots and reports the changes found.

Here is an example illustrating how to use this tool. We start with an existing file tree:

$ tree test/
test
├── a
│   ├── b
│   └── c
│       └── d
└── z

2 directories, 3 files

We take a snapshot of the current state, which will be our reference point in case of later modification:

$ fsdiff snapshot -o before.snap test/

Now, let's shake things up:

$ mkdir test/.x
$ echo y > test/.x/y
$ rm -rf test/a/c/
$ echo z > test/a/b

We now take a second snapshot representing the current state:

$ fsdiff snapshot -o after.snap test/

To know what happened during the two snapshots, we run a diff operation:

$ fsdiff diff before.snap after.snap
+ .x
+ .x/y
~ a
  size:128 mtime:2019-05-19 20:30:22.638232884 +0200 CEST uid:501 gid:20 mode:drwxr-xr-x DIR
  size:96 mtime:2019-05-19 20:33:26.626202277 +0200 CEST uid:501 gid:20 mode:drwxr-xr-x DIR
~ a/b
  size:2 mtime:2019-05-19 20:30:22.528923845 +0200 CEST uid:501 gid:20 mode:-rw-r--r-- checksum:89e6c98d92887913cadf06b2adb97f26cde4849b
  size:2 mtime:2019-05-19 20:33:38.893340925 +0200 CEST uid:501 gid:20 mode:-rw-r--r-- checksum:3a710d2a84f856bc4e1c0bbb93ca517893c48691
- a/c
- a/c/d

2 new, 2 modified, 2 deleted

Similar to the traditional diff tool, the fsdiff diff command's exit status has a specific meaning: 0 means no differences were found, 1 means some differences were found, and 2 means trouble.

Installation

Pre-compiled binaries

Pre-compiled binaries for GNU/Linux and macOS are available for stable releases.

Using Homebrew

On macOS, you can use the Homebrew packaging system:

brew tap falzm/fsdiff
brew install fsdiff

Using go get

go get github.com/falzm/fsdiff

From source (requires a Go compiler >= 1.16)

At the top of the sources directory, just type make fsdiff. If everything went well, you should end up with binary named fsdiff in your current directory.

Usage

Usage documentation is available by running the fsdiff help command.

Note: when performing a diff operation, the command will exit with a return code 2 if changes have been detected between two snapshots, and 0 if no changes. Any other error returns 1.

File exclusion

During a snapshot, it is possible to specify exclusion patterns using the --exclude and --exclude-from flags to prevent matching files from being included in the resulting snapshot. The format used is compatible with the gitignore format: please refer to the documentation to learn more about it.

Note: patterns specified with the --exclude flag are evaluated after the patterns listed in the file --exclude-from and are added to the global patterns list. This means that you can override an exclusion pattern specified in the file by providing the same pattern in inclusion mode (i.e. by prefixing it with !).

Shallow mode

fsdiff supports a shallow mode, in which files checksum are not computed. This can be useful if snapshotting very large file trees and/or large files as the operation will be much less resource-intensive, at the cost of a less precise change tracking: in shallow mode it is not possible to detect file renamings or content-focused file changes anymore.

To use shallow mode, set the --shallow command flag during a snapshot operation. Note: during a diff operation, if fsdiff detects that either one of the snapshots is shallow the operation will be performed in shallow mode too.