diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CLI.md | 87 | ||||
| -rw-r--r-- | doc/TUI.md | 138 | ||||
| -rw-r--r-- | doc/example-list.toml | 21 | ||||
| -rw-r--r-- | doc/pics/export.png | bin | 0 -> 118324 bytes | |||
| -rw-r--r-- | doc/pics/image.png | bin | 0 -> 985392 bytes | |||
| -rw-r--r-- | doc/pics/speed.png | bin | 0 -> 963193 bytes |
6 files changed, 246 insertions, 0 deletions
diff --git a/doc/CLI.md b/doc/CLI.md new file mode 100644 index 0000000..63ca92f --- /dev/null +++ b/doc/CLI.md @@ -0,0 +1,87 @@ +# CLI Usage + +hoardom can run as a normal CLI tool for quick domain lookups. + +written before i went nuts making the tui tool + +## Basic Usage + +```bash +# search a name across all TLDs in the Standard list +hoardom coolproject + +# search a specific full domain +hoardom coolproject.io + +# search multiple domains at once +hoardom coolproject mysite bigidea +``` + +## Modes + +| Flag | Description | +|---------|----------------------------------------------------| +| `--cli` | Default non-interactive mode (implied when no flag) | +| `--tui` | Launch the Terminal UI | + +## Basics + +| Flag | Description | +|-----------------------------|-------------------------------------------------------------------| +| `-e, --environement=PATH` | Where to store the `.hoardom` config folder | +| `-a, --all` | Show all results including unavailable domains | +| `-h, --help` | Basic help | +| `-H, --fullhelp` | Full help with all flags | + +## Advanced + +| Flag | Description | +|-----------------------------|-------------------------------------------------------------------| +| `-c, --csv[=PATH]` | Output as CSV. If PATH is given writes to file, otherwise stdout | +| `-l, --list=LIST` | TLD list to use: `Standard`, `Decent`, `Country`, `All` | +| `-i, --import-filter=PATH` | Import a custom TOML TLD list for this session | +| `-t, --top=TLD,TLD` | Pin certain TLDs to the top of results | +| `-o, --onlytop=TLD,TLD` | Only search these specific TLDs | +| `-s, --suggestions=NUMBER` | How many alternative suggestions to show (default: 0 / disabled) | + +## Various + +| Flag | Description | +|-----------------------------|-------------------------------------------------------------------| +| `-j, --jobs=NUMBER` | Number of concurrent lookup requests (default: 1). Controls how many TLDs are looked up at the same time. Higher values speed up searches but may trigger rate limiting from RDAP/WHOIS servers. Max 99. | +| `-D, --delay=SECONDS` | Delay in seconds between lookup requests | +| `-R, --retry=NUMBER` | Retry count on lookup errors (default: 1) | +| `-V, --verbose` | Verbose output for debugging | +| `-A, --autosearch=FILE` | Search domains from a text file (one per line) | +| `-C, --no-color` | Monochrome output | +| `-U, --no-unicode` | ASCII-only output (no unicode box drawing) | +| `-M, --no-mouse` | Disable mouse integration in TUI | +| `-r, --refresh-cache` | Force refresh the RDAP bootstrap cache | + +## Examples + +```bash +# fast search with 8 concurrent requests +hoardom -j 8 coolproject + +# search with the Country TLD list +hoardom -l Country mysite + +# only check .com and .net +hoardom -o com,net bigidea + +# CSV output to file +hoardom -c results.csv coolproject + +# CSV to stdout (no logs) +hoardom -c coolproject + +# search domains from a file +hoardom -A domains.txt + +# import a custom list and search +hoardom -i custom-tlds.toml coolproject + +# verbose with retry and delay +hoardom -V -R 3 -D 0.5 coolproject +``` diff --git a/doc/TUI.md b/doc/TUI.md new file mode 100644 index 0000000..ff1a501 --- /dev/null +++ b/doc/TUI.md @@ -0,0 +1,138 @@ +# TUI Usage + +dis da fun mode. makes u feel like hackerman or smth, launch it with: + +```bash +hoardom --tui +``` + +or from source like a true alpha: + +```bash +cargo run -- --tui +``` + +you can also pass CLI flags alongside `--tui` and theyll apply as the starting config. like if you want to start with the Country list and some prioritized TLDs: + +```bash +hoardom --tui --list Country --top ch,li +``` + +## layout + +the TUI has a few panels: + +- **search bar** at the bottom: type your domain names here then obliterate enter to hacksor them +- **results** in the middle: shows whats available and whats taken +- **favorites** on the right side: your watchlist on pulling the trigger and shelling out moneu for em domainers +- **settings** below favorites: toggle stuff duh +- **scratchpad** on the left (if enabled in toggler settings): just a little text area for gathering inspiration and other stuff like amongus memes or the bee movie script (saves to config.toml btw so u dont loose your mommy asmr converted to base64 that you saved in ur notes) + +and since version 2.0.1 theres also a top bar with an export button and help button. + +## searching + +type a domain suffix or full domain in the search bar and press Enter. you can search multiple things at once seperated by spaces or commas: + +``` +coolproject shitproject durchfall +``` + +or mix full domains and suffixes: + +``` +coolproject.ch shitproject +``` + +results stream in as they come back, theres a progress bar at the top of the results panel during a search. + +press `s` during a search to cancel it if youre impatient. + +if `Clear on Search` is off in settings, results accumulate across searches. press `C` to clear manually. + +## keyboard shortcuts + +### global +| key | what | +|-----|------| +| `F1` | toggle help overlay | +| `F2` | open/close export popup | +| `Ctrl+C` | quit | +| `s` | cancel running search | +| `Tab` / `Shift+Tab` | cycle between panels | +| `Esc` | close help/dropdown, or clear selection in current panel | + +### search bar +| key | what | +|-----|------| +| `Enter` | start the search | +| typing | works normally when no search is running | +| `Home` / `End` | jump to start/end of input | + +### results +| key | what | +|-----|------| +| `Up` / `Down` | navigate the list | +| `Enter` | add highlighted domain to favorites | +| mouse scroll | scroll through results | + +### favorites +| key | what | +|-----|------| +| `Up` / `Down` | navigate | +| `Backspace` / `Delete` | remove the focused favorite | + +### settings +| key | what | +|-----|------| +| `Up` / `Down` | move between settings rows | +| `Enter` / `Space` | toggle checkboxes or open the TLD list dropdown | + +### scratchpad +as was already said... put whatever u want in here + +## mouse and scrolling support +mouse is on by default. you can click and interact with stuff + +if you hate mouse in terminal apps (or your terminal doesnt like it for reasons) can be disabled : + +```bash +hoardom --tui --no-mouse +``` + +## settings panel + +theres 4 things in there: + +- **TLD List** dropdown: pick Standard, Decent, Country, All, or any custom imported lists +- **Show Unavailable** checkbox: toggles whether taken domains show with premium details in results +- **Show Notes Panel** checkbox: toggles the scratchpad panel on the left +- **Clear on Search** checkbox: if on, results get cleared before each new search. if off they pile up for the true hoarding feeling. + +oh and settings auto save to config + +## favorites + +when you find a domain you like in the results, highlight it and press Enter to add it to favorites. favorites show up in the right panel and persist across sessions. + +if you (for whatever reason) decide to stop hoard domains in ther you can REMOVE THEM OMG WHAT CRAZY AHH FEATURE I KNOW RIGHT ???, focus the favorites panel, navigate to it, and hit Backspace or Delete. + +## export + +press `F2` or click the Export batten in the top bar. + +two modes: +- **Favorites TXT**: dumps your favorites list to a text file, one per line, usefull if u wanna search em all for availability and shiet again. +- **Results CSV**: exports currently visible results as CSV ... if u want that. + +will warn u when u bouta overwrite ur precious files and also last used export paths get remembered for faster extorting. + +## the too small thing + +if you resize the terminal too small, hoardom will refuse to work and complain about being claustrophone! please respect its feelings and dont scare it like that + +## tips + +- you can pass `--import-filter` alongside `--tui` to import a list and jump straight into the TUI with it +- `--verbose` works in TUI too, it prints debug stuff to stderr (which you wont see in the TUI itself, but its there if you redirect it) +- `--no-color` also works here for your 90's dial up crt tty diff --git a/doc/example-list.toml b/doc/example-list.toml new file mode 100644 index 0000000..cc35628 --- /dev/null +++ b/doc/example-list.toml @@ -0,0 +1,21 @@ +# Example custom TLD list for hoardom +# Import with: hoardom -i docs/example-list.toml <domain> +# +# The name field is required and used to identify the list. +# Importing a list with the same name replaces the old one. +# The tlds array defines which TLDs to search. +# Order matters - domains are shown in the same order as listed here. + +name = "Tech Startup" +tlds = [ + "com", + "io", + "dev", + "app", + "tech", + "ai", + "co", + "net", + "org", + "sh", +] diff --git a/doc/pics/export.png b/doc/pics/export.png Binary files differnew file mode 100644 index 0000000..6bb7044 --- /dev/null +++ b/doc/pics/export.png diff --git a/doc/pics/image.png b/doc/pics/image.png Binary files differnew file mode 100644 index 0000000..a2d10b4 --- /dev/null +++ b/doc/pics/image.png diff --git a/doc/pics/speed.png b/doc/pics/speed.png Binary files differnew file mode 100644 index 0000000..8937a1b --- /dev/null +++ b/doc/pics/speed.png |
