Skip to main content

CLI wrapper around the Let's Debug API for diagnosing Let's Encrypt certificate issuance issues

Project description

lets-debug-helper

CI Coverage Status PyPI Python License: MIT

A small command-line wrapper around the Let's Debug public API. Hand it a domain name and it submits a diagnostic test, polls until the result is ready, and prints any problems found in a readable, color-coded format. Useful when you're trying to figure out why Let's Encrypt won't issue a certificate for a domain you control.

Install

pip install lets-debug-helper

Requires Python 3.13+.

Usage

lets-debug example.com

Wildcards are supported:

lets-debug "*.example.com"

For full options:

lets-debug --help

Example output

When the domain has issues:

Checking Domain: example.com
     Testing ID: 2916375
            URL: https://letsdebug.net/example.com/2916375

Waiting for test to complete....

Warning Type: IssueFromLetsEncrypt
 Explanation: A test authorization for example.com to the Let's Encrypt staging
              service has revealed issues that may prevent any certificate for
              this domain being issued.
     Details: Error creating new order :: Cannot issue for "example.com": ...
    Severity: Error

When everything checks out:

Checking Domain: yourdomain.com
     Testing ID: 2916380
            URL: https://letsdebug.net/yourdomain.com/2916380

Waiting for test to complete....

All OK!

No issues were found with yourdomain.com. If you are having problems with
creating an SSL certificate, please visit the Let's Encrypt Community forums
and post a question there.
https://community.letsencrypt.org/

What it checks

The Let's Debug service runs a battery of pre-flight checks that frequently catch the real reasons certificate issuance fails. A non-exhaustive list:

  • DNS resolution and authoritative-NS sanity
  • CAA records that disallow Let's Encrypt
  • Public-suffix-list / domain blocklist hits
  • HTTP-01 reachability (port 80 open, no redirect loops, correct content type)
  • TXT record state for DNS-01 (when applicable)
  • Cloudflare / CDN-fronted SSL configuration warnings
  • IPv4/IPv6 reachability mismatches
  • Rate-limit-state hints from Let's Encrypt's staging environment

For the full list and underlying logic, see the Let's Debug source.

Exit codes

Code Meaning
0 Test completed successfully (regardless of whether problems were reported)
1 API error, JSON decode error, or test did not complete within 60 seconds

Contributing

See CONTRIBUTING.md for dev setup, the make targets, and the release process.

License

MIT.

Acknowledgements

This tool is just a thin client. All the diagnostic work is done by the Let's Debug project — please consider supporting them.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lets_debug_helper-1.6.4.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lets_debug_helper-1.6.4-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file lets_debug_helper-1.6.4.tar.gz.

File metadata

  • Download URL: lets_debug_helper-1.6.4.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.13.13 Linux/6.17.0-1010-azure

File hashes

Hashes for lets_debug_helper-1.6.4.tar.gz
Algorithm Hash digest
SHA256 2d5c67183827024ed04e4fe965423a6f44f0124664d0c874427f8ecf75260060
MD5 b1bcaeaacc4bad22bcd7ed601890cabb
BLAKE2b-256 be560a2e4e2bb1bb5eda33450b9943e0da937c855c46b5397b2efe920f71d601

See more details on using hashes here.

File details

Details for the file lets_debug_helper-1.6.4-py3-none-any.whl.

File metadata

  • Download URL: lets_debug_helper-1.6.4-py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.13.13 Linux/6.17.0-1010-azure

File hashes

Hashes for lets_debug_helper-1.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9cbde2dc12caaa666a5f0ee87cf352a264dc643531a3573c9fe584248dc1beef
MD5 8f3c5ffeeb0daacdcae1bef50d2814df
BLAKE2b-256 9177a5120104ff587cbc4e592ad2050986b88d19f239dc69c297fe8c40383ef6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page