io7m | single-page | multi-page | Laurel User Manual 0.99.1-SNAPSHOT
4. Command-Line Interface
Previous
4. Command-Line Interface
Up
4.2. import
Next

# 4.1. Overview

1
The laurel package provides a command-line interface for performing tasks such as importing and exporting datasets. The base laurel command is broken into a number of subcommands which are documented over the following sections.

### 4.1.2. Command-Line Overview

    laurel: usage: laurel [command] [arguments ...]

      The laurel command-line application.

      Use the "help" command to examine specific commands:

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

      Commands:
        export     Export a dataset into a directory.
        help       Show usage information for a command.
        import     Import a directory into a dataset.
        version    Show the application version.

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

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

### 4.1.5. @ Syntax

    $ laurel import --input-directory /tmp/data --output-file output.ldb

    $ (cat <<EOF
    import
    --input-directory
    /tmp/data
    --output-file
    output.ldb
    EOF
    ) > args.txt

    $ laurel @args.txt

6
All subcommands, unless otherwise specified, yield an exit code of 0 on success, and a non-zero exit code on failure.
4. Command-Line Interface
Previous
4. Command-Line Interface
Up
4.2. import
Next
io7m | single-page | multi-page | Laurel User Manual 0.99.1-SNAPSHOT