All Docs
Docs

Guide to the CredMail CLI

Run full domain health checks from your terminal — no account, no login, no browser needed. This guide covers install, usage, real output, and exactly what gets checked.

Quick start

The fastest way to check a domain, no installation required (needs Node.js 18+):

npx credmail check example.com

You'll get a terminal-friendly report with an overall health score, a PASS/WARN/FAIL status for every check, and exact DNS record values you can act on. See Example output below.

Install

The CLI is published to npm as credmail. Requires Node.js 18+. Run it directly without installing:

npx credmail check example.com

Or install globally:

npm install -g credmail
credmail check example.com

Usage

Usage: credmail check <domain>

Run a full domain health check.

Options:
  --help, -h       Show help
  --version, -v    Show version

Examples:
  credmail check credmail.com
  npx credmail check example.com

The CLI accepts a bare domain (example.com). URLs, www. prefixes, and paths are stripped automatically (https://www.example.com/blog is treated as example.com). No API key or account is required.

What's checked

Each check produces a PASS, WARN, or FAIL status:

  • SPF — record present, all mechanism, policy strictness
  • DKIM — signing key at a common selector._domainkey record
  • DMARC — policy record, enforcement policy, aggregate report address
  • MX records — mail exchange records and priorities
  • BIMI — record and HTTPS logo
  • MTA-STS — DNS record and policy file
  • TLS-RPT — reporting record and report URI
  • Blacklists — 119 DNS-based blacklists with delisting URLs
  • Reputation — estimated score across Gmail, Outlook, and Yahoo
  • WHOIS — registrar, dates, nameservers
  • DNS propagation — cross-resolver consistency

Example output

$ npx credmail check credmail.com

  Domain Health Report  —  credmail.com
  ────────────────────────────────────────────────────────────
  Running checks... done (24.3s)

  Overall Score  85/100  Excellent
  █████████████████░░

  ✓  SPF  PASS
     Record Present: Yes
     All Mechanism: Strict (-all)

  ✓  DKIM  PASS
     Found: Yes
     Selector: selector1

  ✓  DMARC  PASS
     Present: Yes
     Policy: quarantine
     Rua: dmarc@credmail.com

  ✓  MX Records  PASS
     MX Records:
       10  alt1.aspmx.l.google.com
       20  alt2.aspmx.l.google.com

  ✓  Blacklists  PASS  (0/119 listed)
     ✓ Clean on all 119 blacklists

  ✓  Reputation  92/100
     ✓ Gmail: Good
     ✓ Outlook: Good
     ✓ Yahoo: Good

  ────────────────────────────────────────────────────────────
  Checked at 2026-07-31T16:02:11.032Z

What the CLI doesn't do

The CLI covers the free, public domain health check only. For everything else, use the full web app:

  • Email verification — single and bulk address verification with deliverability scoring and list hygiene
  • AI agents — Fix, Verification, Pre-Ship, and Warmup agents that analyze your reports and write step-by-step remediation plans
  • Saved history & reports — account-based report history, saved reports, and trend tracking
  • Tools suite — record generators, SPF flattening, DMARC simulator, and header analyzer

Open the full web app

Exit codes

  • 0 — check completed (regardless of score)
  • 1 — invalid domain, unknown command, or unexpected error

The CLI shares its check logic with the website, so results are identical to credmail.com/check.