DomScan CLI

Official command-line client for the DomScan API.

Requires Node.js 18.18 or newer.

Install

npm install -g https://github.com/estevecastells/domscan-cli/releases/latest/download/domscan-cli.tgz

Run the same command to upgrade, then confirm the installed version:

domscan --version

Quick Start

# Show all API operations from the live OpenAPI spec
domscan list

# Target a local DomScan server
domscan --local get-open-api-spec

# Call an authenticated API operation
export DOMSCAN_API_KEY=dsk_your_key_here
domscan check-domain-availability --name acme --tlds com,io

# Use the generic fallback caller
domscan call /v1/status --query name=acme --query tlds=com,io

Base URL Selection

• Default: https://domscan.net
• Local: --local -> http://127.0.0.1:8787
• Custom: --base-url https://staging.example.com

You can also set DOMSCAN_BASE_URL.

Authentication

For authenticated endpoints, provide either:

domscan --api-key dsk_your_key_here get-domain-health --domain example.com

or:

export DOMSCAN_API_KEY=dsk_your_key_here
domscan get-domain-health --domain example.com

Useful Commands

domscan help
domscan list --search ssl
domscan docs get-domain-health
domscan get-tld-detail --tld io
domscan call /v1/prices/bulk --method POST --body '{"tlds":["com","io"]}'

Output

JSON responses are formatted for the terminal by default. Use --compact for one-line JSON or --raw to print the response body unchanged.

Save successful responses, including CSV batch downloads, directly to a file:

domscan get-api-batch-results \
  --job-id job_123 \
  --format csv \
  --output results.csv

Existing files are protected. Add --force only when you intend to replace the output file.

Resources

• API documentation
• CLI releases
• Issues