<commit_before># zakopane

> **NOTE**: This project is free software, a personal project by j39m.
> However, Google LLC owns the copyright on commits
> `677a32b167502f6d5092add7f95178e81acf4d5d` and newer. This does not
> impact your ability to use and to hack at this free software; I
> provide this notice only for attribution purposes.

`zakopane` is a tool that captures filesystem checksums.
The present implementation can be characterized "`sha256sum`, but
recursive."

## Usage

```sh
# Captures checksums of all files under <directory>.
# Not presently implemented.
zakopane checksum <directory>

# Compares zakopane snapshots <before> and <after> using rules defined
# defined in <config>.
zakopane compare --config <config> <before> <after>
```

## "checksum" Subcommand

There are two noteworthy aspects of the behavior of `zakopane checksum`:

1.  `zakopane` does not descend into directories whose names begin with
    a dot.
1.  `zakopane` does not attempt to stay within the same filesystem and
    will happily cross over bind-mounted filesystem boundaries.

## "compare" Subcommand
<commit_msg>README.md: Celebrate `zakopane checksum`<commit_after># zakopane

> **NOTE**: This project is free software, a personal project by j39m.
> However, Google LLC owns the copyright on commits
> `677a32b167502f6d5092add7f95178e81acf4d5d` and newer. This does not
> impact your ability to use and to hack at this free software; I
> provide this notice only for attribution purposes.

`zakopane` is a tool that captures filesystem checksums.
The present implementation can be characterized "`sha256sum`, but
recursive."

## Usage

```sh
# Captures checksums of all files under <directory>.
zakopane checksum <directory>

# Compares zakopane snapshots <before> and <after> using rules defined
# defined in <config>.
zakopane compare --config <config> <before> <after>
```

## "checksum" Subcommand

There are two noteworthy aspects of the behavior of `zakopane checksum`:

1.  `zakopane` does not descend into directories whose names begin with
    a dot.
1.  `zakopane` does not attempt to stay within the same filesystem and
    will happily cross over bind-mounted filesystem boundaries.

## "compare" Subcommand

{'fraction_non_alphanumeric': 0.07657657657657657, 'fraction_numerical': 0.02972972972972973, 'mean_word_length': 4.81413612565445, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 29, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3557914', 'n_tokens_mistral': 711, 'n_tokens_neox': 642, 'n_words': 288}