io7m | single-page | multi-page | epub | Certusine User Manual
7. Command-Line Interface
Previous
7. Command-Line Interface
Up
7.2. check-configuration
Next

# 7.1. Overview

1
The certusine package provides a command-line interface for performing tasks such as starting the server, checking configuration files, generating keypairs, etc. The base certusine command is broken into a number of subcommands which are documented over the following sections.

### 7.1.2. Command-Line Overview

    certusine: usage: certusine [command] [arguments ...]

      The certusine ACME client.

      Use the "help" command to examine specific commands:

        $ certusine help help.

      Command-line arguments can be placed one per line into a file, and
      the file can be referenced using the @ symbol:

        $ echo help > file.txt
        $ echo help >> file.txt
        $ certusine @file.txt

      Commands:
        check-configuration         Check configuration file.
        generate-keypair            Generate keypairs.
        help                        Show usage information for a command.
        looseleaf-download          Download certificates from looseleaf databases.
        renew                       Renew certificates.
        show-certificate-outputs    Show supported certificate outputs.
        show-dns-configurators      Show supported DNS configurators.
        version                     Show the application version.

      Documentation:
        https://www.io7m.com/software/certusine/

3
All subcommands accept a --verbose parameter that may be set to one of trace, debug, info, warn, or error. This parameter sets the lower bound for the severity of messages that will be logged. For example, at debug verbosity, only messages of severity debug and above will be logged. Setting the verbosity to trace level effectively causes everything to be logged, and will produce large volumes of debugging output.
4
The certusine command-line tool uses quarrel to parse command-line arguments, and therefore supports placing command-line arguments into a file, one argument per line, and then referencing that file with @. For example:

### 7.1.5. @ Syntax

    $ certusine check-configuration --file config.xml

    $ (cat <<EOF
    check-configuration
    --file
    config.xml
    EOF
    ) > args.txt

    $ certusine @args.txt

6
All subcommands, unless otherwise specified, yield an exit code of 0 on success, and a non-zero exit code on failure.
7. Command-Line Interface
Previous
7. Command-Line Interface
Up
7.2. check-configuration
Next
io7m | single-page | multi-page | epub | Certusine User Manual