[![](https://git.klemek.fr/klemek/cool-domain/actions/workflows/lint.yml/badge.svg?branch=main&style=flat-square)](https://git.klemek.fr/klemek/cool-domain/actions?workflow=lint.yml) [![](https://git.klemek.fr/klemek/cool-domain/actions/workflows/test.yml/badge.svg?branch=main&style=flat-square)](https://git.klemek.fr/klemek/cool-domain/actions?workflow=test.yml)

# Cool Domain

> Find a cool unclaimed domain names from the terminal

## Quickstart

Run either from python3, [pipx](https://pipx.pypa.io/stable/) or [uvx](https://docs.astral.sh/uv/guides/tools/)

```bash
# install with pip
python3 -m pip install git+https://git.klemek.fr/klemek/cool-domain
python3 -m cool-domain

# run with pipx
pipx run --spec git+https://git.klemek.fr/klemek/cool-domain cool-domain

# run with uvx
uvx --from git+https://git.klemek.fr/klemek/cool-domain cool-domain
```

## Usage

```txt
usage: cool-domain [-h] [--count DOMAIN_COUNT] [--lang {english,french}] [--dig | --no-dig] [--debug | --no-debug] [--quiet | --no-quiet]
                   [--cache | --no-cache] [--cache-file CACHE_FILE] [--tld-list-uri TLD_LIST_URI]

options:
  -h, --help            show this help message and exit
  --count DOMAIN_COUNT  number of domains to generate (default: 1)
  --lang {english,french}
                        word list lang (default: english)
  --dig, --no-dig       check availability with dig (default: true)
  --debug, --no-debug
  --quiet, --no-quiet
  --cache, --no-cache   use cache (default: true)
  --cache-file CACHE_FILE
                        cache file location (default: /tmp/.cool-domain-cache)
  --tld-list-uri TLD_LIST_URI
                        Top Level Domains list (default: https://publicsuffix.org/list/public_suffix_list.dat)
```