Overview

1

The brooklime package provides a command-line interface for performing tasks such as creating, closing, releasing, listing, and examining Nexus staging repositories. The base brooklime command is broken into a number of subcommands which are documented over the following sections.

2

1.1.2 Command-Line Overview

Usage: brooklime [options] [command] [command options]
  Options:
    --verbose
      Set the minimum logging verbosity level
      Default: info
      Possible Values: [trace, debug, info, warn, error]
  Commands:
    close      Close an existing staging repository
      Usage: close [options]
        Options:
          --baseURI
            The Nexus URI
            Default: https://oss.sonatype.org:443/
        * --password
            The Nexus password
        * --repository
            The staging repository ID
        * --stagingProfileId
            The Nexus staging profile id
        * --user
            The Nexus user name
          --verbose
            Set the minimum logging verbosity level
            Default: info
            Possible Values: [trace, debug, info, warn, error]

    create      Create a staging repository
      Usage: create [options]
        Options:
          --baseURI
            The Nexus URI
            Default: https://oss.sonatype.org:443/
        * --description
            The staging repository description
        * --password
            The Nexus password
        * --stagingProfileId
            The Nexus staging profile id
        * --user
            The Nexus user name
          --verbose
            Set the minimum logging verbosity level
            Default: info
            Possible Values: [trace, debug, info, warn, error]

    drop      Drop an existing staging repository
      Usage: drop [options]
        Options:
          --baseURI
            The Nexus URI
            Default: https://oss.sonatype.org:443/
        * --password
            The Nexus password
        * --repository
            The staging repository ID
        * --stagingProfileId
            The Nexus staging profile id
        * --user
            The Nexus user name
          --verbose
            Set the minimum logging verbosity level
            Default: info
            Possible Values: [trace, debug, info, warn, error]

    list      List the current staging repositories
      Usage: list [options]
        Options:
          --baseURI
            The Nexus URI
            Default: https://oss.sonatype.org:443/
        * --password
            The Nexus password
        * --stagingProfileId
            The Nexus staging profile id
        * --user
            The Nexus user name
          --verbose
            Set the minimum logging verbosity level
            Default: info
            Possible Values: [trace, debug, info, warn, error]

    release      Release an existing staging repository
      Usage: release [options]
        Options:
          --baseURI
            The Nexus URI
            Default: https://oss.sonatype.org:443/
        * --password
            The Nexus password
        * --repository
            The staging repository ID
        * --stagingProfileId
            The Nexus staging profile id
        * --user
            The Nexus user name
          --verbose
            Set the minimum logging verbosity level
            Default: info
            Possible Values: [trace, debug, info, warn, error]

    show      Show an existing staging repository
      Usage: show [options]
        Options:
          --baseURI
            The Nexus URI
            Default: https://oss.sonatype.org:443/
        * --password
            The Nexus password
        * --repository
            The staging repository ID
        * --stagingProfileId
            The Nexus staging profile id
        * --user
            The Nexus user name
          --verbose
            Set the minimum logging verbosity level
            Default: info
            Possible Values: [trace, debug, info, warn, error]

    upload      Upload files to an existing staging repository
      Usage: upload [options]
        Options:
          --baseURI
            The Nexus URI
            Default: https://oss.sonatype.org:443/
        * --directory
            The directory containing files to be uploaded
        * --password
            The Nexus password
        * --repository
            The staging repository ID
        * --stagingProfileId
            The Nexus staging profile id
        * --user
            The Nexus user name
          --verbose
            Set the minimum logging verbosity level
            Default: info
            Possible Values: [trace, debug, info, warn, error]

    version      Show the application version
      Usage: version [options]
        Options:
          --verbose
            Set the minimum logging verbosity level
            Default: info
            Possible Values: [trace, debug, info, warn, error]

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 brooklime command-line tool uses jcommander 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.1.5 @ Syntax

$ brooklime list --user someone --password notarealpassword --stagingProfileId c608eebdbad499e5fd3eb6d6
ID                               Status   Description
example-1000                     open     Implicitly created (auto staging).
example-1001                     open     Implicitly created (auto staging).
example-1002                     open     Implicitly created (auto staging).

$ (cat <<EOF
list
--user
someone
--password
notarealpassword
--stagingProfileId
c608eebdbad499e5fd3eb6d6
EOF
) > args.txt

$ brooklime @args.txt
ID                               Status   Description
example-1000                     open     Implicitly created (auto staging).
example-1001                     open     Implicitly created (auto staging).
example-1002                     open     Implicitly created (auto staging).

6

All subcommands, unless otherwise specified, yield an exit code of 0 on success, and a non-zero exit code on failure.