Simple command line argument parsing

Version on this page:1.2.2
LTS Haskell 9.21:1.2.3
Stackage Nightly 2017-12-06:1.2.3
Latest on Hackage:1.2.3

See all snapshots ReadArgs appears in

BSD-3-Clause licensed by Noah Luck Easterly
Maintained by [email protected]
This version can be pinned in stack with:ReadArgs-1.2.2@sha256:cf178dbd3f2ba97d7cf99bc78866c26e8ed331f23a2b7f390e89905f66cedf97,3021

Module documentation for 1.2.2

  • ReadArgs
Used by 1 package in lts-0.7(full list with versions):

ReadArgs provides the readArgs IO action, which lets you tell the compiler to parse the command line arguments to fit the type signature you give.

For example (a :: Int, b :: String, c :: Float) <- readArgs would parse the first runtime argument as an Int, the second as a String (no quotes required) and the third as a Float.

If the runtime arguments are incompatible with the type signature, then a simple usage statement is given of the types needed.

Continuing the previous example, if it was used in a program named Example, the error message for the above action would be:

usage: Example Int String Float

Any type that has both Typeable and Read instances can be used. Char, String, and Text are handled specially so that command line arguments for both do not require quotes (as their Read instances do). A special instance is provided for FilePath so that no constructor or quotes are required.

readArgs also supports optional arguments and variadic arguments. Optional arguments are specified using Maybe, and variadic arguments using a list. (a :: Int, b :: Maybe String, c :: [Float]) <- readArgs would successfully parse any of the following sets of command line arguments:

Example 1
Example 1 2 3 4
Example 1 foo
Example 1 foo 2 3 4

But not

Example foo
Example 1.0

Usage statements for optional and variadic arguments use command-line parlance:

usage: Example Int [String] [Float..]

Note that both optional and variadic parsers are greedy by default (so Example 1 2 3 4 was parsed as (1, "2", [3.0,4.0]). They may both be made non-greedy through use of the NonGreedy constructor:

( a :: Int
, NonGreedy b :: NonGreedy Maybe String
, NonGreedy c :: NonGreedy [] Float
) <- readArgs