CLI Guide

This guide describes the changes between the v4 and v5 versions of the command line.

{{% notice style="caution" %}}

Please run the new v5 command lego migrate before running any other commands.

This command will migrate the file structure to the new one.

This is a requirement.

This command will not work if you were using the deprecated --filename flag.

If you need help, please open a discussion.

{{% /notice %}}

Commands

The global flags have been moved to flags of the commands.

Example:

# Before
lego --dns foo -d '*.example.com' -d example.com run

# After
lego run --dns foo -d '*.example.com' -d example.com

The command renew has been removed because the command run is able to renew certificates.

The command list has been removed and replaced by accounts list and certificates list.

The command revoke has been removed and replaced by certificates revoke.

Flags

Some flags have been changed, renamed or removed:

Directory structure

The directory structure has been changed.

{{< tabs groupid="migration-examples" >}} {{% tab title="v4" %}}

.
├── accounts
│   └── <server-name-1>
│       ├── <account-name-1>
│       │   ├── account.json
│       │   └── keys
│       │       └── <account-name-1>.key
│       └── <account-name-2>
│           ├── account.json
│           └── keys
│               └── <account-name-2>.key
└── certificates
    ├── example.com.crt
    ├── example.com.issuer.crt
    ├── example.com.json
    ├── example.com.key
    ├── example.org.crt
    ├── example.org.issuer.crt
    ├── example.org.json
    └── example.org.key

{{% /tab %}} {{% tab title="v5" %}}

.
├── accounts
│   └── <server-name-1>
│       ├── <account-name-1>
│       │   ├── account.json
│       │   └── <account-name-1>.key
│       └── <account-name-2>
│           ├── account.json
│           └── <account-name-2>.key
└── certificates
    ├── example.com.crt
    ├── example.com.issuer.crt
    ├── example.com.json
    ├── example.com.key
    ├── example.org.crt
    ├── example.org.issuer.crt
    ├── example.org.json
    └── example.org.key

{{% /tab %}} {{< /tabs >}}

Environment variables

The following environment variables have been removed without replacement:

• SELECTEL_BASE_URL
• VSCALE_BASE_URL

The following environment variables related to the hook have been renamed:

CommonName

The support of the common name is disabled by default.

PEM encoding

Lego uses PKCS#8 instead of PKCS#1 for PEM encoding.

Default resolver/nameserver fallbacks

The default resolver/nameserver fallbacks have been changed.

{{< tabs groupid="migration-examples" >}} {{% tab title="v4" %}}

• google-public-dns-a.google.com:53
• google-public-dns-b.google.com:53

{{% /tab %}} {{% tab title="v5" %}}

• 1.1.1.1:53
• 1.0.0.1:53
• [2606:4700:4700::1111]:53
• [2606:4700:4700::1001]:53

{{% /tab %}} {{< /tabs >}}