crcutil 3.0.0

No project description provided

CRCutil

Portable CRC32 Checksum Tool – Generate & Compare

[!NOTE] Installation is supported for the following:

• Windows (amd64)
• Linux (amd64)
  • X11
  • Wayland
• MacOS (arm64)

Table of Contents

• Installation
• Usage
  • crc
  • diff
  • pause/resume
• Logs
• Development
• Known Issues

Installation

[!NOTE]

• Requires Python 3.11+
  

Windows & Linux (X11)

pip install crcutil

Linux (Wayland)

[!CAUTION]

• This will add your user to the input group and immediately log you out.
• This makes it possible in Wayland to track keyboard presses; necessary for the playback controls

pip install crcutil
sudo usermod -aG input $USER
sudo pkill -u $USER

MacOS

[!NOTE]

• Enable Accesibility Access for the Terminal on System Settings > Privacy & Security > Accessibility
• This makes it possible in MacOS to track keyboard presses; necessary for the playback controls

pip install crcutil

Usage

crc

Generate CRC32 checksums

[!NOTE]

• This will output a crc.json file in the supplied -o argument.
• If no -o supplied a crc.json is created in the current directory.
• If a crc.json already exists in the current directory, a crc2.json is created.

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

[!TIP]

• Make CRCutil run faster by disabling playback controls -f

crcutil crc -f -l 'C:\path_to_traverse'

---

diff

Diff output can be generated from 2 separate crc files

[!NOTE]

• This will compare both crc files and output a diff.json in the supplied -o argument.
  
• If no -o supplied a diff.json is created in the current directory.
• If no -l supplied it will look for a crc.json and crc2.json in the current directory

crcutil diff -l 'C:\crc1.json' 'C:\crc2.json' -o 'C:\diff.json'

---

Pause/Resume

[!CAUTION] The crc can only be resumed as long as the contents/structure of the traversed location have not changed

[!NOTE] To resume a crc after exiting, pass the location of the existing crc to the -o flag
i.e: crcutil crc -l 'C:\path_to_traverse' -o 'C:\existing_crc.json'

• The tool can be paused/resumed at any time by pressing:
  • p
    • Windows
    • Linux (X11)
    • MacOS
  • alt+p
    • Linux (Wayland)
• The tool can be exited at any time by pressing:
  • q
    • Windows
    • Linux (X11)
    • MacOS
  • alt+q
    • Linux (Wayland)

Logs

[!NOTE] Logs can be found in:

• Windows -> C:\Users\User\Documents\crcutil\log
• Linux -> $XDG_STATE_HOME/crcutil/log
• MacOS -> ~/Library/Application Support/crcutil/log

Development

[!NOTE] Only Ubuntu environments supported

source init.sh

Known Issues

• Playback controls on remote graphical sessions (NX, VNC, RDP, etc...) are not currently supported.

License

GNU GPLv3