aboutsummaryrefslogtreecommitdiff
path: root/doc/CLI.md
blob: ac088772b3e065638a2c7af4746571dc517549ec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

   

CLI Usage

hoardom can run as a normal CLI tool for quick domain lookups. this file was partually made and kept up to date by agents as I suck at writing docs as one might notice from tui.md lmao.

Basic Usage

# 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 (kinda useless tbh )
--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: 32) 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

# fast search with 64 concurrent requests
hoardom -j 64 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