Command Reference

This document provides detailed information about all available commands in hashreport.

Global Options

Option	Description
`--help`	Show help message and exit
`--version`	Show version and exit

Commands

scan

Generate a hash report for files in a directory.

hashreport scan [OPTIONS] DIRECTORY

Options

Option	Default	Description
`DIRECTORY`	-	Directory to scan
`-a, --algorithm`	`md5`	Hash algorithm to use
`-f, --format`	`csv`	Output format (csv, json)
`-o, --output`	-	Output directory
`-r, --recursive`	`True`	Scan directories recursively
`-i, --include`	-	Include files matching pattern
`-e, --exclude`	-	Exclude files matching pattern
`--regex`	`False`	Use regex patterns
`--min-size`	-	Minimum file size
`--max-size`	-	Maximum file size
`--limit`	-	Limit number of files
`--email`	-	Email address for report
`--from`	-	Sender address (defaults to `--email` if not set)
`--smtp-host`	-	SMTP server host
`--smtp-port`	-	SMTP server port
`--smtp-user`	-	SMTP username
`--smtp-password`	-	SMTP password
`--test-email`	`False`	Test email configuration

filelist

Generate a list of files in a directory (paths only, no hashes). Supports the same include/exclude and size filters as scan.

hashreport filelist [OPTIONS] DIRECTORY

Options

Option	Default	Description
`DIRECTORY`	-	Directory to scan
`-o, --output`	-	Output file or directory (default: current directory, writes `filelist.txt`)
`-r, --recursive`	`True`	Scan directories recursively
`--include`	-	Include files matching pattern (repeatable)
`--exclude`	-	Exclude files matching pattern (repeatable)
`--regex`	`False`	Use regex for include/exclude patterns
`--min-size`	-	Minimum file size (e.g. 1MB)
`--max-size`	-	Maximum file size (e.g. 1GB)
`--limit`	-	Limit number of files listed

view

View report contents.

hashreport view [OPTIONS] REPORT_FILE

Options

Option	Default	Description
`REPORT_FILE`	-	Report file to view
`-f, --filter`	-	Filter entries by pattern

compare

Compare two report files.

hashreport compare [OPTIONS] OLD_REPORT NEW_REPORT

Options

Option	Default	Description
`OLD_REPORT`	-	First report file
`NEW_REPORT`	-	Second report file
`-o, --output`	-	Output directory

config

Manage configuration settings.

hashreport config [OPTIONS] COMMAND

Commands

Command	Description
`show`	Display current configuration
`edit`	Edit configuration file

algorithms

List available hash algorithms.

hashreport algorithms

upgrade

Upgrade hashreport from PyPI using the same Python that runs the CLI. By default installs the latest version; use --version to install a specific version.

hashreport upgrade [OPTIONS]

Options

Option	Default	Description
`-V, --version`	latest	Install a specific version (e.g. `1.2.3`)

Examples

# Upgrade to latest
hashreport upgrade

# Install a specific version
hashreport upgrade --version 1.2.3
hashreport upgrade -V 1.2.0

Examples

Basic Usage

# Scan directory with default settings
hashreport scan /path/to/directory

# Scan with specific algorithm
hashreport scan --algorithm sha512 /path/to/directory

# Generate multiple formats
hashreport scan -f csv -f json /path/to/directory

Advanced Usage

# Scan with filters
hashreport scan \
  --include "*.pdf" \
  --exclude "*.tmp" \
  --min-size 1MB \
  --max-size 1GB \
  /path/to/directory

# Use regex patterns
hashreport scan \
  --regex \
  --include ".*\d{8}.*" \
  /path/to/directory

# Email report
hashreport scan \
  --email user@example.com \
  --smtp-host smtp.example.com \
  --smtp-user username \
  --smtp-password password \
  /path/to/directory

For more information, see: - Basic Usage - Advanced Usage - Configuration Guide - Troubleshooting