HoardKit v1.0

HoardKit is a lightweight, dependency-free command-line toolkit designed for encoding/decoding, hashing, pattern extraction, and hash identification. Optimized for Linux and macOS environments, HoardKit enables users to quickly process and analyze text or file data with a simple and intuitive interface.

---

🚀 Features

Global Options

• -f, --file <FILE> Read input from a file (mutually exclusive with -i).
• -i, --input <TEXT> Provide raw text input directly.
• --version Display the current version (v1.0).
• --debug Enable detailed debug-level logging.
• --log-file <FILE> Specify a file to write logs to (defaults to stderr when debug is enabled).
• --quiet Suppress standard output while preserving exit codes.
• -h, --help Show global or command-specific help information.

Commands

Command	Description	Supported Formats / Algorithms
encode	Encode input using various formats	base64, base64_url, base32, base32hex, hex, hex_upper, ascii85, base85, rot13, binary, uuencode, url, punycode, quoted_printable
decode	Decode input from supported formats	Same as encode
hash	Compute cryptographic hashes and checksums	md4, md5, sha1, sha224, sha256, sha384, sha512, sha3_224, sha3_256, sha3_384, sha3_512, blake2b, blake2s, ripemd160, whirlpool, crc32, adler32, shake_128, shake_256
search	Extract patterns such as emails, IPs, URLs, and more	emails, ips, urls, macs, credit_cards, dates
identify	Identify hash algorithms by signature or length	Detects common hash types based on input digest

Each command supports -h or --help for detailed usage instructions.

---

🛠️ Installation

Quick Start

# Clone the repository
git clone https://github.com/HoarderMe/hoardkit.git
cd hoardkit

# Make the main script executable
chmod +x hoardkit

# Run with global help
./hoardkit --help

Optional: Global Installation

To use hoardkit system-wide from anywhere on your machine:

sudo cp hoardkit /usr/local/bin/
hoardkit --help

Optional: Enable Shell Autocompletion (bash)

pip install argcomplete           # Install argcomplete
activate-global-python-argcomplete --user
# Restart your shell or source the autocompletion file

---

🎯 Usage Examples

# Encode text to Base64
hoardkit -i "hello" encode base64

# Decode a hex string from stdin
echo "68656c6c6f" | hoardkit decode hex

# Compute SHA256 hash of a file
hoardkit -f /path/to/file hash sha256

# Extract all URLs from a text file
cat file.txt | hoardkit search urls

# Identify an unknown hash digest
echo "5d41402abc4b2a76b9719d911017c592" | hoardkit identify

# Show help for the encode command
hoardkit encode --help

# Enable debug logging and write logs to a custom file
hoardkit -i "hello" --debug --log-file mylog.txt encode base64

---

📚 Supported Formats & Algorithms

Operation	Supported Types / Algorithms
encode/decode	base64, base64_url, base32, base32hex, hex, hex_upper, ascii85, base85, rot13, binary, uuencode/uudecode, url, punycode, quoted_printable
hash	md4, md5, sha1, sha224, sha256, sha384, sha512, sha3_224, sha3_256, sha3_384, sha3_512, blake2b, blake2s, ripemd160, whirlpool, crc32, adler32, shake_128, shake_256
search	emails, ips, urls, macs, credit_cards, dates

---

🧳 Exit Codes

Code	Meaning
0	Success
1	Internal error
2	User error (invalid arguments/input)
130	Process canceled (e.g., via Ctrl+C)

---

📄 Logging

• Enable debug mode using --debug.
• Use --log-file <FILE> to write logs to a file.
• Without --debug, logging is suppressed.
• If no log file is specified, logs are printed to stderr when debug is enabled.

---

📄 License

HoardKit is released under the MIT License. © 2025 HoarderMe

---