# 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

```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 (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-list=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

```bash
# 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
```
