diff options
Diffstat (limited to 'doc/CLI.md')
| -rw-r--r-- | doc/CLI.md | 87 |
1 files changed, 87 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 +``` |
