diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CLI.md | 61 | ||||
| -rw-r--r-- | doc/TUI.md | 2 |
2 files changed, 31 insertions, 32 deletions
@@ -1,8 +1,7 @@ # CLI Usage hoardom can run as a normal CLI tool for quick domain lookups. - -written before i went nuts making the tui tool +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 @@ -19,44 +18,44 @@ hoardom coolproject mysite bigidea ## Modes -| Flag | Description | -|---------|----------------------------------------------------| -| `--cli` | Default non-interactive mode (implied when no flag) | -| `--tui` | Launch the Terminal UI | +| 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 | +| 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) | +| 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). 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 | +| 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 @@ -28,7 +28,7 @@ the TUI has a few panels: - **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. +and since version 1.0.1 theres also a top bar with an export button and help button. ## searching |