Forrest logo
tool overview
On this page you find all important commands for the CLI tool acme.sh. If the command you are looking for is missing please ask our AI.

acme.sh

acme.sh is a popular command line tool used for managing SSL/TLS certificates. It is lightweight, flexible, and written in pure Unix shell script, making it compatible with most Linux distributions and even macOS. Here are some key features and functionalities of acme.sh:

  1. Certificate Issuance: acme.sh allows you to issue free SSL/TLS certificates from Let's Encrypt Certificate Authority. It supports both single domain and wildcard certificates.

  2. DNS API Integration: If you don't have direct control over your server's DNS, acme.sh provides an API integration to automatically issue certificates using popular DNS providers like Cloudflare, Route53, or GoDaddy.

  3. Automatic Renewal: With acme.sh, you can set up a cron job for automatic certificate renewal. It also performs intelligent renewal, ensuring that only certificates that need to be renewed are processed.

  4. Certificate Deployment: acme.sh can also automatically install your certificates on various web servers, including Apache, Nginx, Caddy, and others. It supports reload/restart of the server after certificate renewal.

  5. ACMEv2 Support: acme.sh fully supports ACMEv2 protocol, which is required for issuing wildcard certificates.

  6. Portable: Since it is written in shell script, acme.sh can be easily run from any location, and you can also use it on different servers without needing to install any additional dependencies.

  7. Flexible Configuration: acme.sh provides a wide range of configuration options and parameters, allowing you to customize the issuance and renewal process based on your specific requirements.

  8. Extensibility: acme.sh has a plugin architecture, enabling you to add your own custom DNS providers or hooks for additional functionality.

Overall, acme.sh is a powerful and widely used command line tool that simplifies the process of obtaining and managing SSL/TLS certificates, making it convenient for securing your web applications or websites.

List of commands for acme.sh:

  • acme.sh-dns:tldr:1997f acme.sh-dns: Issue a certificate using a manual DNS mode.
    $ acme.sh --issue --dns --domain ${example-com} --yes-I-know-dns-manual-mode-enough-go-ahead-please
    try on your machine
    explain this command
  • acme.sh-dns:tldr:244ec acme.sh-dns: Issue a certificate while disabling automatic Cloudflare / Google DNS polling after the DNS record is added by specifying a custom wait time in seconds.
    $ acme.sh --issue --dns ${dns_namecheap} --domain ${example-com} --dnssleep ${300}
    try on your machine
    explain this command
  • acme.sh-dns:tldr:428f8 acme.sh-dns: Issue a certificate using a DNS alias mode.
    $ acme.sh --issue --dns ${dns_cf} --domain ${example-com} --challenge-alias ${alias-for-example-validation-com}
    try on your machine
    explain this command
  • acme.sh-dns:tldr:a717b acme.sh-dns: Issue a certificate using an automatic DNS API mode.
    $ acme.sh --issue --dns ${gnd_gd} --domain ${example-com}
    try on your machine
    explain this command
  • acme.sh-dns:tldr:a8bdc acme.sh-dns: Issue a wildcard certificate (denoted by an asterisk) using an automatic DNS API mode.
    $ acme.sh --issue --dns ${dns_namesilo} --domain ${example-com} --domain ${*-example-com}
    try on your machine
    explain this command
  • acme.sh:tldr:2e864 acme.sh: Issue a certificate using a working Nginx configuration.
    $ acme.sh --issue --nginx --domain ${example-com}
    try on your machine
    explain this command
  • acme.sh:tldr:50f42 acme.sh: Issue a certificate using webroot mode.
    $ acme.sh --issue --domain ${example-com} --webroot ${-path-to-webroot}
    try on your machine
    explain this command
  • acme.sh:tldr:871de acme.sh: Issue a certificate for multiple domains using standalone mode using port 80.
    $ acme.sh --issue --standalone --domain ${example-com} --domain ${www-example-com}
    try on your machine
    explain this command
  • acme.sh:tldr:8a1f5 acme.sh: Issue a certificate using a working Apache configuration.
    $ acme.sh --issue --apache --domain ${example-com}
    try on your machine
    explain this command
  • acme.sh:tldr:8cd16 acme.sh: Install certificate files into the specified locations (useful for automatic certificate renewal).
    $ acme.sh --install-cert -d ${example-com} --key-file ${-path-to-example-com-key} --fullchain-file ${-path-to-example-com-cer} --reloadcmd ${"systemctl force-reload nginx"}
    try on your machine
    explain this command
  • acme.sh:tldr:b932d acme.sh: Issue a certificate using standalone TLS mode using port 443.
    $ acme.sh --issue --alpn --domain ${example-com}
    try on your machine
    explain this command
tool overview