The cli-builder package

[Tags:library, mit, test]

Please see README.md


[Skip to Readme]

Properties

Versions 0.1.0
Dependencies base (>=4.7 && <5), either, exceptions (>=0.8.0.2), optparse-applicative (>=0.12 && <0.14), transformers (>=0.3.0.0 && <0.6) [details]
License MIT
Copyright 2016 uecmma
Author uecmma
Maintainer developer@mma.club.uec.ac.jp
Category Tool
Home page https://github.com/uecmma/haskell-library-collections/tree/master/cli-builder
Bug tracker https://github.com/uecmma/haskell-library-collections/issues
Source repository head: git clone git+https://gitlab.mma.club.uec.ac.jp/uecmma/haskell-library-collections.git
Uploaded Wed Nov 9 09:59:53 UTC 2016 by mizunashi_mana
Distributions NixOS:0.1.0
Downloads 51 total (7 in the last 30 days)
Votes
0 []
Status Docs not available [build log]
All reported builds failed as of 2016-11-17 [all 2 reports]
Hackage Matrix CI

Modules

  • System
    • CLI
      • System.CLI.Builder
        • System.CLI.Builder.Internal
        • System.CLI.Builder.Option
        • System.CLI.Builder.Types

Flags

NameDescriptionDefaultType
test-doctestEnabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for cli-builder

Readme for cli-builder-0.1.0

CLI Builder

This packages contains builders to make cli application easily based optparse-applicative.

Getting Started

Here is a simple example:

{-# LANGUAGE RecordWildCards #-}

import System.CLI.Builder

data Options = Options
  { isSampleOption :: Bool
  } deriving (Eq, Show)

optionsParser :: OptionParser Options
optionsParser = Options
  <$> switch (long "sample" <> help "Sample switch")

cliInfo :: CLIInfo
cliInfo = baseCLIInfo "Simple CLI" "Example for simple CLI"

run :: Options -> IO ()
run Options{..} = do
  putStrLn "Sample application"
  putStrLn $ "Is sample: " ++ show isSampleOption

main :: IO ()
main = buildSimpleCLI cliInfo optionsParser run

This action is such as:

$ sampleApp
Sample application
Is sample: False
$ sampleApp --sample
Sample application
Is sample: True
$ sampleApp --help
Simple CLI

Usage: <interactive> [--help]
  Example for simple CLI

Available options:
  --help                   Show this help text
  --sample                 Sample switch

For more examples, see examples.