aboutsummaryrefslogtreecommitdiff
path: root/doc/CLI.md
diff options
context:
space:
mode:
authorUMTS at Teleco <crt@teleco.ch>2026-03-08 22:11:52 +0100
committerUMTS at Teleco <crt@teleco.ch>2026-03-08 22:11:52 +0100
commit17c6bd803dbbecb8975b1b98532d25a807a7b3fb (patch)
treebc0e339ca514414261ce211ab0f74101e6d8aefa /doc/CLI.md
parentee17cec85d3d9ef2abc0d7a50c980d82b429b59d (diff)
docs and font fix
Diffstat (limited to 'doc/CLI.md')
-rw-r--r--doc/CLI.md61
1 files changed, 30 insertions, 31 deletions
diff --git a/doc/CLI.md b/doc/CLI.md
index 4f53102..ac08877 100644
--- a/doc/CLI.md
+++ b/doc/CLI.md
@@ -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