diff options
| author | UMTS at Teleco <crt@teleco.ch> | 2026-03-08 22:11:52 +0100 |
|---|---|---|
| committer | UMTS at Teleco <crt@teleco.ch> | 2026-03-08 22:11:52 +0100 |
| commit | 17c6bd803dbbecb8975b1b98532d25a807a7b3fb (patch) | |
| tree | bc0e339ca514414261ce211ab0f74101e6d8aefa /README.md | |
| parent | ee17cec85d3d9ef2abc0d7a50c980d82b429b59d (diff) | |
docs and font fix
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 210 |
1 files changed, 108 insertions, 102 deletions
@@ -4,13 +4,13 @@ Allows you to HOARd DOMains but with alot less pain associated with it. > "How to get my IP unbanned by Whois servers" <br> > -- Probably you after using this tool. -## Lates Update : tool now has a wrapper app for desktop* folks! +## Latest Update : tool now has a wrapper app for desktop* folks! (No windows support only unix.) Use the new make file to either `make pkg` for macass or `make deb` for debian systems. If you are running gentoo or anything else just the usual `make install`, to uninstall do `make uninstall` obv. (both install and uninstall will require le sudo or root) <div style="width:80%; margin: auto;"> - + </div> @@ -23,151 +23,157 @@ In short the threeish interfaces serve the following purposes : - TUI : Allows you to hunt and keep track of domain (name) ideas and quickly search up what is available and what isnt right in your unix terminal of choice - GUI : Is a wrapper for the TUI that gives it its own icon in your app menu and when opened in dock/taskbar incase you wish to not use it that way. -## How do I install `hoardom`? -`hoardom`'s tui and especially its gui interface officially only supports Unix based systems, Windows was net tested! <br> The regular cli interface should work with the built in main lookup and fallback whois implementations on Windows but that hasn't been tested. +## planed features +that will probably not come because I have no time. +- search within results -### Debian - -```bash -# Install RustUp Toolchain (Optional if already installed) -curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh - -# clone this repo -https://git.teleco.ch/crt/hoardom.git/about/?h=master - -``` - -> <br> - -> **_Question:_** Whats the like main use for this tool?<br><hr> -> -**_Answer:_** To allow looking up whether or not domain names are available or already registered without scrolling for ages through a long and slow web ui by your domain registrar of choice or needing to go through like 3 sites to cover all domain registrars you might use. <br> -> - -> <br> - -> **_Question:_** I dont need GUI all I want is a simple command?<br><hr> - -> **_Answer:_** Ofcourse! That was the initial idea, simply type : <br> -> --> `hoardom somedomain.com` to see if a specific domain is free <br> -> --> `hoardom somedomain` to check which top 100ish tlds are free <br> -> --> `hoardom -l all -a somedomain` to check all 600ish registerable domain names and explicitly show which ones are already taken <br> <br> - -> **_Note:_** If you need stuff like csv outputs or other silly features check [the CLi docs](doc/CLI.md) <br> +## Further screenshots +Have some screenshots I took as to know what will expect you and mainly for me to flex a bit. +### Its fast : +Searching the default domain list returns results of the top 100ish tlds in just **_1-3 seconds!_** +<div style="width:80%; margin: auto;"> -Dont believe me on this being the best? Fair, but what if one of my test subjects* described to you how it felt to use this tool : + -> THIS IS THE BEST domain hoarding tool ever!!! Ive gone completely mental and now have loads and loads of debt because I bought a bunch of worthless domains I will do nothing with! +</div> -*(the subject was me and voices i got in my head making this) +*(list of top 100ish tlds is a bit biased by my preference obviously) +<hr> -Dont wanna use its TUI? Fine it can also run as a normal CLI tool if you just wanna search some stuff real quick and move on with your sad chud life before going insane and launching it in TUI mode and start HOARDING you favorites, scribble your schizophrenia into its scratchpad and lose all your money to domains you wont ever use <3 +Searching availability for all domains I was able to compiled which are purchasable through either : Porkbun, INWX or OVH (~637 Domains) will take only **_10-20 Seconds!_** -## what this thing does +<div style="width:80%; margin: auto;"> -- searches suffixes or full domains across TLD lists -- has a TUI mode with: - - results - - favorites - - settings - - scratchpad - - exports -- has a CLI mode for quick searches, scripts or sigma terminal maxxers. -- lets you import custom TLD lists from toml files because I wont bother keeping a list of "technically obtainable ones" up to date (Check and edit List.toml before compiling if the embedded ones I prepared dont satisfy you) -- keeps a `.hoardom` config folder with your saved stuff - - favorites - - imported lists - - em notes - - settings - - cach and stuff idk + -## known bugs -- missing basic ah tui features -- half of the app untested its 6am i havent slept leave me alone -- scrolling then selecting something sometimes takes a while until the button hitboxes catch up with scrolling (if using mouse or touchpad that is) -- will display fallse positives for some domains that have a minimum length that this tool doesnt know about (usually 4/5 lette domains where ur part is only 2) +</div> -## planed features -that will probably not come because I have no time. -- search within results +Btw theres even tracking of you your favorites! Showing a persistant " ! " for domains that changed from unavailable to available (and reverse). To make it go away you'll need highlighting it and press enter (its meant so that no change goes unnoticed) -## more screenshots +### Export popup -### speedy as fuck ? heck yea !!! +you can export stuff from tui wow!, tbh I dont know what else to show its pretty cool, check yourself tbh. It obviously can do full mouse support to and scrollwheel support is also there if you want -How long does it takes to search all domains purchasable through either : Porkbun, INWX or OVH (~637 Domains)? 15ish seconds on wifi at my home most time coming from retries at some uglier tlds - + -Oh and ofcourse you can save favorites and check their status here and there, if one changes it shows an ! next to it until you confirm it with enter. +## How do I install `hoardom`? +`hoardom`'s tui and especially its gui interface officially only supports Unix based systems, Windows was net tested! <br> The regular cli interface should work with the built in main lookup and fallback whois implementations on Windows but that hasn't been tested. -### export popup +### Debian +Not tested yet tbh. Probably wont build the GUI wrapper but should still add a desktop entry shortcut for opening it in terminal -you can export stuff from tui wow! +```bash +# Install RustUp Toolchain (Optional if already installed) +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh - +# clone and enter this repo +git clone https://git.teleco.ch/crt/hoardom.git && cd hoardom -### cli example +# make deb and install +make deb +sudo dpkg -i target/deb/hoardom*.deb +``` -Have a banger name for a website but dont know what domains for that name are free ? just type hoardom <domainsuffix> and it gives you the answer in two seconds! - +### Other Linuxes +Not tested yet tbh. Same as above. -## quick start +```bash +# Install RustUp Toolchain (Optional if already installed) +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -if you just wanna run it from source real quick: +# clone and enter this repo +git clone https://git.teleco.ch/crt/hoardom.git && cd hoardom -```bash -cargo run -- --tui +# build and install +make +sudo make install ``` -some normal CLI examples: +### MacDonalds OS +Also known as MacOS ```bash -cargo run -- pissnelke -cargo run -- drowogen.network -cargo run -- --list Country hoardom -``` +# Install RustUp Toolchain (Optional if already installed) +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -import a custom list and jump into the TUI: +# clone and enter this repo +git clone https://git.teleco.ch/crt/hoardom.git && cd hoardom -```bash -cargo run -- --import-filter ./doc/example-list.toml --tui +# make pkg installation file. +make pkg ``` +After that go to the target/release folder and install the PKG file. +### Uninstall +``` +sudo make uninstall +``` -## docs - -the proper usage docs live here cause i didnt want this readme to turn into a kilometer ah receipt paper +### Minimal Q&A on getting started +And potentially fun facts. -- [CLI usage](doc/CLI.md) -- [TUI usage](doc/TUI.md) +> <br> - +> **_Question:_** How do I open the TUI?<br><hr> - +> **_Answer:_** With : `hoardom` <br> -so yeah if you want the actual button for button docs go there, but expect part of it to be llm slop as i am not writing a manual describing each button or feature for what was supposed to be a 2 hour simple cli tool that turned into a 1.5 day project because i have too much spice. +> <br> - +> **_Question:_** I dont need GUI all I want is a simple command?<br><hr> - +> **_Answer:_** Ofcourse! That was the initial idea, simply type : <br> +> --> `hoardom somedomain.com` to see if a specific domain is free <br> +> --> `hoardom somedomain` to check which top 100ish tlds are free <br> +> --> `hoardom -l all -a somedomain` to check all 600ish registerable domain names and explicitly show which ones are already taken <br> <br> - +> **_Note:_** If you need stuff like csv outputs or other silly features check [the CLi docs](doc/CLI.md) <br> -## custom lists +#### Custom lists +As this is mentioned below as a fix to a bigger problem ive added this here (also partially because i forgot to rename import filter to import list, earlier typo that survived for too long) -there is an importable example file here: +Tldr you can make custom search list see example : [`doc/example-list.toml`](doc/example-list.toml) -- [`doc/example-list.toml`](doc/example-list.toml) +Custom lists are basically a really simple toml file with a name and the `tlds` array. +To import them/update them use `hoardom --import-filter ./path/to/list.toml --tui` -custom lists are just simple toml files with a name and a `tlds` array. -example shape: +## Docs -```toml -name = "somecoollist" -tlds = ["com", "io", "dev", "sh"] -``` +the proper usage docs live here cause i didnt want this readme to become like 1km long (its already too long anyways) -then import it with: +- [CLI usage](doc/CLI.md) +- [TUI usage](doc/TUI.md) -```bash -cargo run -- --import-filter ./path/to/list.toml --tui -``` -which ads it to your config.toml environment filet -yes i know its supposed to be named import-list ... i forgot to change it but im not fixing that now, is from when i used a different list fetching method. +## Known Problems +Just so you know + how to get arround some of the bigger ones. + +- **_BIG ISSUES_** + - + - *Problem* : Not fully ready for microdomains, If searched for SLD is only 1-3 chars some false positives from TLDs that dont allow such short SLDs are possible if that domain isnt registered. + - Temp Fix : Make custom list that excludes the missbehaving + - *Problem* : No support for special characters like ö ä ü + - Temp Fix : Type prefix `xn--` and the punycode for ur special character by hand or use a converter. +- **_Meh Issues_** + - + - Problem : No real like settings pop up panel in TUI to control rest of configuration options in TUI + - Edit your settings manually, by default in ~/.hoardam/config.toml +- **_Tiny Issues_** + - scrolling then selecting something by mouse might select wrong thing as hitboxes for selection cant updated fast enough due to spasming touchpad scroll events. + - Temp Fix : Be Patient and give it like 1-5 seconds to catch up and dont scroll as fast + +## How much Slop can I expect in this repo? +Usually comments were left for things that had unusally high amounts of things not done by me. If code has like ... very minimal or barely any comments its probably my own spaghetti code. If its got a bunch of em that look overly gramatically correct it was done by an llm, heres infos as i believe projects should state their usage of ai so I can avoid pure slop projects on GH that only work halfways : + +- General Infos + - Basically all used agentic LLMs were ran on my own hardware at home. + - Extensive systemprompt was writen to fix some basic typical garbage behaviour by agents + - This project shouldve never taken more than a few hours... However i spiraled and went nuts making it too capable because I got a rush of hyperfocus for it for while +- Where and for what were they used : + - Bugfixing, Internet Research and Repetitive work : + - Project is a bit of a mess as I lacked time to neatly split up repetitive functions into modules and didnt trust ai doing it. Bugfixing occassionally was guided by models capable of browsing the internet via mcp as googles search results are becoming worse and worse by day and i cant find crap anymore thanks to all the sponsored and ai slop that google itself already shoves in my face. + - Documentation and Comments : + - All docs and code commends usually get looked over by Agentic LLMs and incase things were in German/Swiss-German they were translated to english and if they contained swearing it shouldve been removed. Places that have unusally high ammounts of comments might be bugfixes done by ai, didnt really tell it to make comments for me just sanetize mine. -## did i use ai for coding this ? -for helping me fix bugs yea obv. other than that only some markdown structures and basic crap i didnt wanna do or as guidance on how to go about stuff was done by llms and comments to the code were sanetized from very harsh swearing by an llm lol. |