Files
poli0981andClaude Opus 5.5 dcfe5c6b7c docs: maintenance mode
From 1.3.0 Hash Tool is in maintenance mode. What it accepts is written down once, in CONTRIBUTING.md ("Project
status"): security fixes (high/critical vulnerabilities in .NET or a dependency get a prompt release), dependency and
.NET updates, bug and UI/UX fixes, accessibility, translation fixes, and hash algorithms on real demand; no new
features unless truly necessary.

- README: maintenance, Qodana and .NET 10 LTS badges and a "Project status" section.
- CONTRIBUTING: the policy, the issue forms, and the hash algorithm candidates (BLAKE2b-512, SHA3-256/512, CRC-32C)
  with what each would take; ARCHITECTURE: a checklist for adding an algorithm.
- Issue forms: the feature request form is replaced by "Hash algorithm request" and "Translation problem"; feature
  ideas go to Discussions (Ideas). The accessibility form gives the email address for people who cannot use GitHub.
- Pull request template: the kinds of change that are accepted.
- SECURITY: 1.3.x supported, the security commitment during maintenance, Qodana among the checks.
- CLAUDE.md: the project status for agents.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-16 09:20:51 +07:00

161 lines
8.3 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# HashTool 🛠️
[![Release](https://img.shields.io/github/v/release/poli0981/HashTool?sort=semver)](https://github.com/poli0981/HashTool/releases/latest)
[![CI](https://github.com/poli0981/HashTool/actions/workflows/ci.yml/badge.svg)](https://github.com/poli0981/HashTool/actions/workflows/ci.yml)
[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=poli0981_HashTool&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=poli0981_HashTool)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=poli0981_HashTool&metric=coverage)](https://sonarcloud.io/component_measures?id=poli0981_HashTool&metric=coverage)
[![Qodana](https://github.com/poli0981/HashTool/actions/workflows/qodana.yml/badge.svg)](https://github.com/poli0981/HashTool/actions/workflows/qodana.yml)
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/poli0981/HashTool/badge)](https://scorecard.dev/viewer/?uri=github.com/poli0981/HashTool)
[![Maintenance mode](https://img.shields.io/badge/status-maintenance%20mode-blue.svg)](#project-status)
[![.NET 10 LTS](https://img.shields.io/badge/.NET-10%20LTS-512BD4.svg)](https://dotnet.microsoft.com/download/dotnet/10.0)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![Downloads](https://img.shields.io/github/downloads/poli0981/HashTool/total.svg)](https://github.com/poli0981/HashTool/releases)
**A friendly desktop app for Windows, macOS and Linux that generates and verifies file hashes and checksum files — no terminal commands required.** A small `hashtool` command-line tool comes along for when you do want the terminal.
Built with C# on .NET 10 and Avalonia UI.
## Project status
**Maintenance mode** since Hash Tool 1.3.0 (November 2026). Hash Tool keeps getting security fixes, dependency and .NET
updates, bug fixes, accessibility and translation fixes, and new hash algorithms when someone needs one — but no new
features. Details: [CONTRIBUTING.md](CONTRIBUTING.md#project-status-maintenance-mode) and the
[announcement](https://github.com/poli0981/HashTool/discussions/categories/announcements).
## Motivation
Why open a terminal and type cryptic commands just to hash a file?
HashTool was born out of pure laziness — a simple, intuitive GUI to do the job without the hassle.
## Screenshots
![Generate Hash](docs/images/generate.png)
*Generate Hash – batch processing with several export options*
![Verify Hash](docs/images/verify.png)
*Verify Hash – checksum files, sidecar detection and batch verification*
![Settings](docs/images/setting_screenshot_1.png)
*Settings – themes, languages, performance and limits*
![Dark Mode](docs/images/dark.png) *Dark mode – because who doesn't love dark mode?*
More: [About](docs/images/about.png) · [Update](docs/images/update.png) · [Developer console](docs/images/dev.png) · [Settings 2](docs/images/setting_screenshot_2.png)
## Features
### Generate Hash
- Drop files or whole folders (or use Add Files / Add Folder); folders are scanned in the background.
- Several files are hashed at once; each file is read only once, whatever the algorithm.
- Export all results as **one checksum file** — GNU (`sha256sum` style), BSD tagged, SFV, JSON or CSV — with paths relative to where you save it.
- Save a single hash next to its file (`photo.jpg.sha256`), copy hashes, or bundle them into a ZIP with a `CHECKSUMS.txt` manifest.
### Verify Hash
- Drop or open a checksum file (`SHA256SUMS`, `*.sha256`, `*.md5`, `*.sfv`, BSD tagged lists, xxhsum output…) and every file it lists is loaded and checked.
- Drop a file alone and HashTool finds its sidecar (`image.iso.sha256`, `image.iso.md5`…) automatically.
- Paste an expected hash, or drop a hash file onto a row; the algorithm is guessed from the file name or the hash length when needed.
- Clear results: **VALID**, **MISMATCH**, missing files, access denied, files in use, time-outs.
### Hash Text
- Type or paste text and see its hash in every algorithm, updated as you type, with a copy button for each.
- Choose UTF-8 or UTF-16 and LF or CRLF line breaks; nothing is added at the end, so the result matches
`printf '%s' 'text' | sha256sum`.
### Everything else
- **11 algorithms**: MD5, SHA-1, SHA-256, SHA-384, SHA-512, BLAKE3, xxHash32, xxHash64, XXH3, XXH128, CRC32 (MD5 and SHA-1 are fine for detecting corruption, not for security).
- **67 languages** with automatic detection and right-to-left layouts.
- Light/dark/system, eight theme styles (including colour-blind friendly and high contrast), fonts and UI scale.
- Hash masking, settings lock, file size/count limits, per-file time-out, hard-drive mode.
- **System integration**: Explorer right-click menu on Windows (optional), "Open With" on macOS, `--create`/`--verify` command-line arguments.
- Automatic update check (at most once a day, can be turned off) with release notes; updates install in place.
- Developer console with live logs.
- **Accessible**: works with the keyboard alone and with screen readers, statuses in words rather than colour alone,
and readable contrast in every theme — see [ACCESSIBILITY.md](ACCESSIBILITY.md).
> Hashing speed depends mostly on your drive (SSD vs HDD) and system load. Turn on *Optimize for hard drives* in Settings for spinning disks and network shares.
## Installation
Download from the [latest release](https://github.com/poli0981/HashTool/releases/latest):
| Platform | Installer | Portable |
|---|---|---|
| Windows 10/11 (x64) | `HashTool-win-Setup.exe` | `HashTool-win-Portable.zip` — extract, run `HashTool.exe` |
| macOS, Apple silicon | `HashTool-osx-Setup.pkg` | `HashTool-osx-Portable.zip` |
| macOS, Intel | `HashTool-osx-x64-Setup.pkg` | `HashTool-osx-x64-Portable.zip` |
| Linux (x64) | — | `HashTool.AppImage` |
**macOS:** the app is not signed yet (no Apple Developer account 😅), so Gatekeeper may complain. Right-click the app → **Open**, or allow it in *System Settings → Privacy & Security*.
**Linux:** make the AppImage executable (`chmod +x HashTool.AppImage`) and run it. AppImages need FUSE 2 (`sudo apt install libfuse2` on Ubuntu/Debian).
Installed and portable copies update themselves from the *Update* page.
### Command-line tool
`hashtool-<version>-<platform>` archives contain a single native executable — no .NET install needed.
```text
hashtool hash photo.jpg # sha256sum-style line
hashtool hash -r ./dist -o ./dist/SHA256SUMS # every file in a folder, paths relative to the output
hashtool hash -a sha256,blake3 big.iso # several algorithms, one read (BSD tagged output)
hashtool verify SHA256SUMS # like sha256sum -c: exit 0 = all OK, 1 = mismatch/missing
hashtool check big.iso -e 4f2c… # one file against one hash (algorithm guessed from length)
printf '%s' 'hello' | hashtool hash - # text from standard input
hashtool algorithms
```
See [docs/USAGE.md](docs/USAGE.md) for every option and the app's command-line arguments.
## Verifying downloads
Every release includes `SHA256SUMS` and GitHub build provenance attestations:
```text
sha256sum -c SHA256SUMS --ignore-missing
gh attestation verify HashTool-win-Setup.exe --repo poli0981/HashTool
```
## Building from source
Requires the [.NET 10 SDK](https://dotnet.microsoft.com/download) (10.0.404 or newer).
```text
dotnet build HashTool.slnx
dotnet test --solution HashTool.slnx
dotnet run --project src/HashTool.App
dotnet run --project src/HashTool.Cli -- hash README.md
```
How the code is organised: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md). How releases are made: [docs/RELEASING.md](docs/RELEASING.md).
## Contributing
Bug reports, translation fixes and pull requests within the maintenance scope are welcome — see
[CONTRIBUTING.md](CONTRIBUTING.md). Something hard to
use with a keyboard, screen reader or other assistive technology? See [ACCESSIBILITY.md](ACCESSIBILITY.md).
## Legal Stuff
- [LICENSE (MIT)](LICENSE)
- [EULA](docs/EULA.md)
- [Disclaimer](docs/DISCLAIMER.md)
- [Terms of Service](docs/ToS.md)
- [Privacy Policy](docs/PrivacyPolicy.md)
- [Security Policy](SECURITY.md)
- [Code of Conduct](CODE_OF_CONDUCT.md)
## Acknowledgements
Big thanks to the open-source community and AI assistants — full credits in [ACKNOWLEDGEMENTS.md](ACKNOWLEDGEMENTS.md).
---
Made with ❤️ (and a lot of coffee) by poli0981
*© 2026 poli0981. Released under the MIT License.*