simple-cmd-args: Simple command args parsing and execution

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

This is a small wrapper over optparse-applicative which allows combining args parsers directly with IO commands. For subcommands this can avoid type boilerplate. It also provides some compact aliases for options with their Mod's.

[Skip to Readme]

Properties

Versions	0.1.0, 0.1.0.1, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.1.5, 0.1.6, 0.1.6, 0.1.7, 0.1.8
Change log	CHANGELOG.md
Dependencies	base (>=4 && <5), optparse-applicative (>=0.14.1), semigroups [details]
License	BSD-3-Clause
Copyright	2019-2020 Jens Petersen
Author	Jens Petersen
Maintainer	juhpetersen@gmail.com
Category	System
Home page	https://github.com/juhp/simple-cmd-args
Bug tracker	https://github.com/juhp/simple-cmd-args/issues
Source repo	head: git clone https://github.com/juhp/simple-cmd-args.git
Uploaded	by JensPetersen at 2020-03-25T17:46:05Z

Modules

[Index] [Quick Jump]

SimpleCmdArgs

Downloads

simple-cmd-args-0.1.6.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

JensPetersen

For package maintainers and hackage trustees

edit package information

Readme for simple-cmd-args-0.1.6

[back to package description]

simple-cmd-args

A thin layer over optparse-applicative that avoids type plumbing for subcommands by using Parser (IO ()).

Usage

import SimpleCmdArgs
import Control.Applicative (some)
import System.Directory

main =
  simpleCmdArgs Nothing "example-tool" "Longer description..." $
  subcommands
    [ Subcommand "echo" "Print words" $
      putStrLn . unwords <$> some (strArg "STR...")
    , Subcommand "ls" "List directory" $
      ls <$> strArg "DIR"
    , Subcommand "mkdir" "Create directory" $
      mkdir <$> parentsOpt <*> strArg "DIR"
    ]
  where
    parentsOpt = switchWith 'p' "parents" "Make missing directories"

ls :: FilePath -> IO ()
ls dir =
  listDirectory dir >>= mapM_ putStrLn

mkdir :: Bool -> FilePath -> IO ()
mkdir parents =
  if parents then createDirectoryIfMissing True else createDirectory

See more examples.