Skip to content

hashreport

Python Poetry MkDocs License
CodeQL Testing Security

Overview

hashreport is a command-line tool that generates comprehensive hash reports for files within a directory. The reports can be output in CSV or JSON formats and include detailed information such as the file name, path, size, hash algorithm, hash value, and last modified date. Designed for speed and efficiency, hashreport can handle large volumes of files and offers filtering options to include or exclude files based on size, type, or name patterns.

Quick Start

# Install hashreport
pip install hashreport

# Generate a hash report
hashreport scan /path/to/directory

See the Workflow Overview for a complete guide to using hashreport.

Features

🚀 Core Features

  • Multi-threaded processing for fast bulk hash generation
  • Support for multiple hash algorithms (MD5, SHA-256, etc.)
  • Recursive directory traversal
  • Comprehensive file information in reports

📊 Output Options

  • CSV and JSON report formats
  • Customizable output location
  • Report viewer and comparison tool
  • Email report delivery via SMTP

🔍 Filtering Capabilities

  • Filter by file size (min/max)
  • Filter by file type and name patterns
  • Include/exclude file lists
  • Processing limits and controls

Getting Started

  1. Installation - Set up hashreport on your system
  2. Basic Usage - Learn the fundamentals
  3. Command Reference - Detailed command documentation

Common Use Cases

🔒 File Integrity Checking

  • Generate baseline reports
  • Monitor for changes
  • Verify file integrity

🛡️ Security Auditing

  • Scan sensitive files
  • Track modifications
  • Generate audit trails

💾 Backup Verification

  • Verify backup integrity
  • Compare file states
  • Document changes

Additional Resources

License

This project is licensed under the Affero General Public License v3.0.

Issues and Feedback

Please report any issues or feedback on the GitHub Issues page.