From 7393f0c3144ec3e2dc7b38202e6e9ce577fbddc9 Mon Sep 17 00:00:00 2001 From: Corey Date: Thu, 12 Dec 2024 17:13:25 -0500 Subject: [PATCH] added readme template --- README_TEMPLATE.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 README_TEMPLATE.md diff --git a/README_TEMPLATE.md b/README_TEMPLATE.md new file mode 100644 index 0000000..ac379bd --- /dev/null +++ b/README_TEMPLATE.md @@ -0,0 +1,32 @@ +# Hashcat Kasm Container + +A custom KASM workspace container with Hashcat, CUDA support, and the Adj-Noun Wordlist Generator pre-installed. + +## Features + +- Hashcat with NVIDIA CUDA support +- Pre-installed Adj-Noun Wordlist Generator +- Included rockyou.txt wordlist at `/usr/local/wordlists/rockyou.txt` +- Custom background image + +## Using the Adj-Noun Generator + +The Adj-Noun Generator is pre-installed and available as `adj` command. It generates wordlists combining adjectives and nouns with optional digits. + +### Basic Usage + +```bash +# Basic usage (outputs adjective+noun+1digit and adjective+noun+3digits) +adj + +# Pipe to hashcat +adj | hashcat -m 22000 hash.hc22000 + +# Different digit combinations +adj -0 # No digits +adj -1 # 1 digit +adj -2 # 2 digits +adj -3 # 3 digits + +# Use expanded wordlist +adj -full \ No newline at end of file