System.Console.StructuredCLI

This module provides the tools to build a complete "structured" CLI application, similar to those found in systems like Cisco IOS or console configuration utilities etc. It aims to be easy for implementors to use.

How to use this module:

The following code illustrates a simple but complete CLI app:

import Control.Monad.IO.Class (liftIO)
import System.Console.StructuredCLI

root :: Commands ()
root = do
  world >+ do
    hello
    bye
    exit $ Just "return to previous level"

world :: Commands ()
world = command "world" (Just "enter into world") Nothing

hello :: Commands ()
hello = command "hello" (Just "prints a greeting") $ Just $ do
          liftIO . putStrLn $ "Hello world!"
          return 0

bye :: Commands ()
bye = command "bye" (Just "say goodbye") $ Just $ do
        liftIO . putStrLn $ "Sayonara!"
        return 0

main :: IO ()
main = runCLI "Hello CLI" Nothing root

resulting example session:

>>> Hello CLI > ?
- world: enter into world
>>> Hello CLI > world
>>> Hello CLI world >
bye    exit   hello
>>> Hello CLI world > hello
Hello world!
>>> Hello CLI world > exit

A good way to get you started is to grab the example code available under example/Main.hs and modify it to suit your needs.

type Commands = CommandsT IO

newtype CommandsT m a

Constructors

CommandsT

Fields

• runCommandsT :: m (a, [Node m])

Instances

MonadTrans CommandsT

Methods

lift :: Monad m => m a -> CommandsT m a

Monad m => Monad (CommandsT m)

Methods

(>>=) :: CommandsT m a -> (a -> CommandsT m b) -> CommandsT m b

(>>) :: CommandsT m a -> CommandsT m b -> CommandsT m b

return :: a -> CommandsT m a

fail :: String -> CommandsT m a

Functor f => Functor (CommandsT f)

Methods

fmap :: (a -> b) -> CommandsT f a -> CommandsT f b

(<$) :: a -> CommandsT f b -> CommandsT f a

Applicative a => Applicative (CommandsT a)

Methods

pure :: a -> CommandsT a a

(<*>) :: CommandsT a (a -> b) -> CommandsT a a -> CommandsT a b

(*>) :: CommandsT a a -> CommandsT a b -> CommandsT a b

(<*) :: CommandsT a a -> CommandsT a b -> CommandsT a a

MonadIO m => MonadIO (CommandsT m)

Methods

liftIO :: IO a -> CommandsT m a

data Parser m

Instances

MonadIO m => Default (Parser m)

Methods

def :: Parser m

data ParseResult

Constructors

Done String String

Fail String (Maybe String)

Partial

Instances

Show ParseResult

Methods

showsPrec :: Int -> ParseResult -> ShowS

show :: ParseResult -> String

showList :: [ParseResult] -> ShowS

data Settings

Constructors

Settings

Fields

• history :: Maybe FilePath
• banner :: String
• prompt :: String

Instances

Default Settings

Methods

def :: Settings

(>+) :: Monad m => CommandsT m () -> CommandsT m () -> CommandsT m ()

command :: MonadIO m => String -> Maybe String -> Maybe (Action m) -> CommandsT m ()

exit :: MonadIO m => Maybe String -> CommandsT m ()

mkParser :: MonadIO m => (Bool -> String -> m ParseResult) -> Parser m

outputStrLn :: MonadIO m => String -> InputT m ()

Write a string to the user's standard output, followed by a newline.

param :: Monad m => String -> Maybe String -> Parser m -> Maybe (Action m) -> CommandsT m ()

popCommand :: Monad m => CState m ()

pushCommand :: Monad m => Node m -> String -> CState m ()

runCLI :: MonadException m => String -> Maybe Settings -> CommandsT m () -> m ()

top :: MonadIO m => Maybe String -> CommandsT m ()