DomScan CLI

Official command-line client for the DomScan API.

Install

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

Quick Start

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

# Target a local DomScan Worker
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"]}'