options

A powerful and easy-to-use command-line option parser.

https://john-millikin.com/software/haskell-options/

Version on this page:1.2.1@rev:1
LTS Haskell 23.8:1.2.1.2@rev:2
Stackage Nightly 2025-02-11:1.2.1.2@rev:2
Latest on Hackage:1.2.1.2@rev:2

See all snapshots options appears in

MIT licensed and maintained by John Millikin
This version can be pinned in stack with:options-1.2.1@sha256:e3a956d7492d4c4c114e63d69c10641f68190041cee3301fffacf422d35ca495,3418

Module documentation for 1.2.1

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

The options package lets library and application developers easily work with command-line options.

The following example is a full program that can accept two options, --message and --quiet:

import Control.Applicative
import Options

data MainOptions = MainOptions
    { optMessage :: String
    , optQuiet :: Bool
    }

instance Options MainOptions where
    defineOptions = pure MainOptions
        <*> simpleOption "message" "Hello world!"
            "A message to show the user."
        <*> simpleOption "quiet" False
            "Whether to be quiet."

main :: IO ()
main = runCommand $ \opts args -> do
    if optQuiet opts
        then return ()
        else putStrLn (optMessage opts)

$ ./hello
Hello world!
$ ./hello --message='ciao mondo'
ciao mondo
$ ./hello --quiet
$

In addition, this library will automatically create documentation options such as --help and --help-all:

$ ./hello --help
Help Options:
  -h, --help
    Show option summary.
  --help-all
    Show all help options.

Application Options:
  --message :: text
    A message to show the user.
    default: "Hello world!"
  --quiet :: bool
    Whether to be quiet.
    default: false