MAuth-Client CLI Tool

MAuth-Client provides a Command Line Interface (CLI) tool to make MAuth-signed requests and verify MAuth-signed responses.

Installation

The MAuth-Client CLI is part of the MAuth Client gem, refer to the README for installation instructions.

Configuration

The CLI is configured with a mauth.yml file - see its page for instructions.

The MAuth-Client CLI tool looks for the configuration file in several places:

  • if an environment variable MAUTH_CONFIG_YML points to an existing file, mauth-client will use that file if it exists.
  • if you have a file ~/.mauth_config.yml then it will use that. This is useful if you have your own mauth key.
  • if you are in a directory relative to which a config/mauth.yml exists, it will use that. This is useful if you are working in a project which uses mauth and has a key configured.
  • if you are in a directory in which a file mauth.yml exists, it will use that.

mauth.yml is expected to contain, at the top level, an environment key or keys. mauth-client checks environment variables RAILS_ENV and RACK_ENV to determine the environment, and defaults to 'development' if none of these are set.

Usage

The mauth-client executable should be available with bundle exec, once it has been installed in your Gemfile. If you installed the gem manually, you may not need to run bundle exec.

$ bundle exec mauth-client --help
Usage: mauth-client [options] <verb> <url> [body]
    -v, --[no-]verbose               Run verbosely - output is like curl -v (this is the default)
    -q                               Run quietly - only outputs the response body (same as --no-verbose)
        --[no-]authenticate          Authenticate the response received
        --[no-]color                 Color the output (defaults to color if the output device is a TTY)
    -t, --content-type CONTENT-TYPE  Sets the Content-Type header of the request
    -H, --header LINE                accepts a json string of additional headers to included. IE 'cache-expirey: 10, other: value
        --no-ssl-verify              Disables SSL verification - use cautiously!

Examples:

bundle exec mauth-client GET https://eureka-innovate.imedidata.com/v1/apis

bundle exec mauth-client GET https://eureka-innovate.imedidata.com/v1/deployments

bundle exec mauth-client POST https://eureka-innovate.imedidata.com/v1/deployments '{"baseURI": "https://cupcakes.imedidata.com", "stage": "production", "apis": [{"name": "cupcakes", "version": "v1.0.0"}]}'

Output

MAuth-Client CLI's default output is designed to look like the output of curl -v. It includes all headers, body, and other components of the http request. This can be suppressed with the -q (quiet) option, in which case only the response body will be output. The normal output (not the quiet version) is colorized by default if connected to a tty device (e.g. a terminal).