cli-utils-4.1.0
LicenseBSD3
Maintainertbidne@gmail.com
Safe HaskellNone
LanguageHaskell2010

CLI.Parsing

Description

Handles parsing of [String] args into Env.

Synopsis

Documentation

parseArgs :: [String] -> IO (Either ParseErr Env) Source #

Maps parsed [String] args into IO Right Env, returning any errors as Left String. All arguments are optional (i.e. an empty list is valid), but if any are provided then they must be valid or an error will be returned. Valid arguments are:

  --legend=<string>
      Path to the legend file.

  --timeout=<seconds>
      Non-negative integer. If we reach the timeout then all remaining
      commands will be cancelled. If no timeout is given then the
      timeout is infinite, i.e., we will keep running until all
      commands have finished.

  <string>
      Any other string is considered a command. If the command has
      whitespace then it must be quoted or it will be considered
      a separate command.