crcutil 1.6.1

No project description provided

CRCUtil

A CLI tool that recursively traverses a given location and generates a crc.json containing a CRC checksum value for every encountered file/dir

[!NOTE] Installation is supported only for the following:

• Windows
• Linux

[!NOTE] Development requires a fully configured Dotfiles dev environment

Table of Contents

• Installation
• Usage
  • crc
  • diff
  • pause/resume
• Development

Installation

[!NOTE]

• Requires Python 3.12+
  
• Requires pip

• Windows

pip install crcutil

• Linux

python3 -m pip install crcutil

Usage

crc

crcutil crc -l 'C:\path_to_traverse' -o 'C:\path_to_output.json'

[!NOTE] This will output a crc.json file in the supplied -o argument.
If no -o argument is supplied, then the default output location is:

• Windows

C:\Users\<USERNAME>\Documents\crcutil\

• Linux

$HOME/crcutil

diff

If you hold 2 crc files generated from the same directory and would like to compare the differences.

crcutil diff -l 'C:\crc_1.json' 'C:\crc_2.json' -o 'C:\diff.json'

[!NOTE] This will compare both crc files and output a diff.json in the supplied -o argument.
If no -o argument is supplied, then the default output location is:

• Windows

C:\Users\<USERNAME>\Documents\crcutil\

• Linux

$HOME/crcutil

Pause/Resume

• The tool can be paused/resumed at any time by pressing p.
• The tool can be exited at any time by pressing q (will continue where left off if you invoke the same command).

Development

[!NOTE] Development requires a fully configured Dotfiles dev environment

source init.sh