io7m | single-page | multi-page | Aradine User Manual
3. Command Line
Previous
3. Command Line
Up
3.2. help
Next

# 3.1. Overview

1
The aradine package provides a command-line interface for performing tasks such as managing the local inventory, checking instrument files, and etc. The base aradine-cli command is broken into a number of subcommands which are documented over the following sections.

### 3.1.2. Command-Line Overview

    aradine-cli: usage: aradine-cli [command] [arguments ...]

      Modular programmable synthesis (Command-line).

      Use the "help" command to examine specific commands:

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

      Commands:
        help          Show usage information for a command.
        info          Display system information.
        instrument    Instrument commands.
        inventory     Inventory commands.
        version       Show the application version.

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

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 aradine-cli 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:

### 3.1.5. @ Syntax

    $ aradine-cli instrument check --file sampler.jar
    {
      "Message" : "Instrument passed all checks.",
      "Level" : "INFO"
    }

    $ (cat <<EOF
    instrument
    check
    --file
    sampler.jar
    EOF
    ) > args.txt

    $ aradine-cli @args.txt
    {
      "Message" : "Instrument passed all checks.",
      "Level" : "INFO"
    }

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