checksum-utils

README

Checksum-Utils ✅

Multiplatform file checksum tools

Checksum Utils is a CLI tool to manage the checksum of your files, focused on NAS systems.

✨ Features

• Create checksum files
• Check checksum files

💻 Install

1. Download the latest release from the releases page according to your operating system.

2. Move and rename the downloaded executable to your PATH, so you can use it from anywhere.

   mv ./checksum-utils_linux-amd64 /usr/local/bin/checksum-utils
   

3. Give it execute permissions if necessary:

   chmod 0755 /usr/local/bin/checksum-utils
   

🚀 Usage

Create checksum files

This command reads the files in a folder, gets their checksums, and creates a file with the .sha512 extension with it, so you can have a record of the checksum of that file.

Let's say you want to create the checksum files for your folder "documents":

├── ~
│   ├── documents
│   │   ├── document-1.pdf
│   │   ├── document-2.ppt
│   │   └── document-3.csv
│   ├── music
│   ├── pictures
│   └── videos

Use the command:

checksum-utils create ~/documents

This command will create a .sha512 checksum file for each file in your folder:

├── ~
│   ├── documents
│   │   ├── document-1.pdf
│   │   ├── document-1.pdf.sha512 <-- created by checksum-utils
│   │   │
│   │   ├── document-2.ppt
│   │   ├── document-2.ppt.sha512 <-- created by checksum-utils
│   │   │
│   │   ├── document-3.csv
│   │   └── document-3.csv.sha512 <-- created by checksum-utils
│   ├── music
│   ├── pictures
│   └── videos

Check checksum files

This command reads the content of the files generated by the command "checksum-utils create ~/documents" and compares them with the original file to verify if the checksum remains the same.

Let's say you want to check the checksums of the files of your folder "documents":

├── ~
│   ├── documents
│   │   ├── document-1.pdf
│   │   ├── document-1.pdf.sha512
│   │   │
│   │   ├── document-2.ppt
│   │   ├── document-2.ppt.sha512
│   │   │
│   │   ├── document-3.csv
│   │   └── document-3.csv.sha512
│   ├── music
│   ├── pictures
│   └── videos

Use the command:

checksum-utils check ~/documents

The command will display the results of the comparation of the current checksum of the file with the one stored in the file with the .sha512 extension:

├── ~
│   ├── documents
│   │   ├── document-1.pdf ✅
│   │   │
│   │   ├── document-2.ppt ✅
│   │   │
│   │   └── document-3.csv ❌
│   ├── music
│   ├── pictures
│   └── videos

🏗️ Dev

You must have golang installed on your system.

1. Clone the project:

   git clone https://github.com/JuanOrbegoso/checksum-utils.git
   

2. Install Go dependencies:

   go mod download
   

3. Build:

   make build
   

🧑‍💻 Author

Juan Orbegoso:

• Website: www.juan-orbegoso.dev
• Blog: blog.juan-orbegoso.dev
• Github: @JuanOrbegoso
• LinkedIn: @juan-orbegoso

Documentation

Overview

Copyright © 2025 Juan Orbegoso

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.