io7m | single-page | multi-page | Montarre User Manual 1.0.0-SNAPSHOT
5. Command Line
Previous
5. Command Line
Up
5.2. help
Next

# 5.1. Overview

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

### 5.1.2. Command-Line Overview

    montarre: usage: montarre [command] [arguments ...]

      The montarre command-line application.

      Use the "help" command to examine specific commands:

        $ montarre 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
        $ montarre @file.txt

      Commands:
        help             Show usage information for a command.
        maven-central    Maven Central commands.
        native           Native package commands.
        package          Package commands.
        version          Show the application version.
        wix              WiX commands.

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

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 montarre 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:

### 5.1.5. @ Syntax

    $ montarre package check --file com.io7m.montarre.distribution/target/com.io7m.montarre.distribution-0.0.1-SNAPSHOT.mpk
    ...

    $ (cat <<EOF
    package
    check
    --file
    com.io7m.montarre.distribution/target/com.io7m.montarre.distribution-0.0.1-SNAPSHOT.mpk
    EOF
    ) > args.txt

    $ montarre @args.txt

6
All subcommands, unless otherwise specified, yield an exit code of 0 on success, and a non-zero exit code on failure.
5. Command Line
Previous
5. Command Line
Up
5.2. help
Next
io7m | single-page | multi-page | Montarre User Manual 1.0.0-SNAPSHOT