3 unstable releases
new 0.2.1 | Nov 12, 2024 |
---|---|
0.2.0 | Nov 12, 2024 |
0.1.0 | Nov 11, 2024 |
#169 in Cryptography
362 downloads per month
16KB
231 lines
hashkitten
hashkitten
is a fun command-line tool for hashing text and files that I built to learn Rust.
Table of Contents
Introduction
hashkitten
is your purrfect hashing companion, built with Rust for fast, secure, and delightful hashing of text and files. With hashkitten
, you can hash strings or files and compare hashes with a playful touch.
Features
- Hashes text and file contents
- Supports hash comparison
- Easy-to-read help message
- Outputs fun, purr-styled hashes
Installation
Linux
-
Clone the repository:
git clone https://github.com/username/hashkitten.git cd hashkitten
-
Build the project using Cargo:
cargo build --release
-
Install the compiled binary to a directory in your
$PATH
(e.g.,/usr/local/bin
):sudo install -m 755 target/release/hashkitten /usr/local/bin/
Now you can use
hashkitten
as a command anywhere in your terminal.
MacOS (Intel and Apple Silicon)
-
Clone the repository:
git clone https://github.com/username/hashkitten.git cd hashkitten
-
Build the project using Cargo:
cargo build --release
-
Install the compiled binary to a directory in your
$PATH
(e.g.,/usr/local/bin
):sudo install -m 755 target/release/hashkitten /usr/local/bin/
For Apple Silicon, make sure you have the appropriate toolchain installed:
rustup target add aarch64-apple-darwin
Now you can use
hashkitten
as a command anywhere in your terminal.
Windows
-
Clone the repository:
git clone https://github.com/username/hashkitten.git cd hashkitten
-
Build the project using Cargo:
cargo build --release
-
Add the compiled binary to your system
PATH
:- Locate the compiled binary at
target\release\hashkitten.exe
. - Copy the path to the directory containing
hashkitten.exe
. - Search for "Environment Variables" in the Start Menu, and edit the
PATH
variable to include the path to the binary.
Now you can use
hashkitten
as a command anywhere in your terminal. - Locate the compiled binary at
Usage
Run hashkitten
from the command line with various flags:
hashkitten [FLAGS] ["TEXT"]
Examples
-
Display help message:
hashkitten -h
-
Hash a text string:
hashkitten "Hello, world!"
-
Hash the contents of a file:
hashkitten -f input.txt
-
Compare a message with a given hash:
hashkitten -c "Hello, world!" HASH
Flags
-h
|--help
: Display the help message.-f FILE
|--file FILE
: Hash the contents of the specified file.-c "MESSAGE" HASH
|--compare "MESSAGE" HASH
: Compare the provided message with a given hash.
How It Works
Hashkitten is a playful tool that uses the robust SHA-256 hashing algorithm to generate secure hashes for your text or file content. But that's not all — hashkitten
adds a fun twist by converting the hash into a unique, purr-inspired style using a custom mapping system. 🐾✨
Support
Love what hashkitten
does? Show your support with a ⭐️ and help us make it even better! Got ideas or suggestions? Feel free to open an issue—we'd love to hear from you. Let’s keep those tails wagging! 🐱💻
License
This project is licensed under the MIT License - see the LICENSE file for details.