Documentation

A data type that contains arguments from the command line.

The default CliArgs. This corresponds to the value CliArgs will become when no CLI arguments have been passed.

>>> :{
  let defCliArgs =
        CliArgs
          { cliConfigOptions = defaultCliConfigOptions
          , extraCliArgs = defaultExtraCliArgs
          }
  in defaultCliArgs == defCliArgs
:}
True

CLI arguments that correspond to fields in ConfigOptions.

See ConfigOptions for what each of these options mean.

The default CliConfigOptions. All Options are Unset, which means they won't override options from ConfigOptions in applyCliArgs.

>>> :{
  let defCliConfOpt =
        CliConfigOptions
          { cliConfFontFamily = Unset
          , cliConfFontSize = Unset
          , cliConfShowScrollbar = Unset
          , cliConfScrollbackLen = Unset
          , cliConfConfirmExit = Unset
          , cliConfWordCharExceptions = Unset
          , cliConfShowMenu = Unset
          , cliConfShowTabBar = Unset
          , cliConfCursorBlinkMode = Unset
          , cliConfBoldIsBright = Unset
          , cliConfEnableSixel = Unset
          , cliConfAllowBold = Unset
          }
  in defaultCliConfigOptions == defCliConfOpt
:}
True

Extra CLI arguments for values that don't make sense in ConfigOptions.

The default ExtraCliArgs.

>>> :{
  let defExtraCliArgs =
        ExtraCliArgs
  in defaultExtraCliArgs == defExtraCliArgs
:}
True

Similar to strOption, but specifically work on a value that is an Option.

Similar to option, but specifically work on a value that is an Option.

Similar to maybeReader, but work on Text instead of String.

Helper for making a flag CLI argument that optionally takes a no- prefix.

Example:

'optionFlag' 'True' 'False' 'f' 'n' "foo" "Does foo" "Does not do foo" :: Parser (Option Bool)

This creates a Parser that accepts both a --foo and a --no-foo flag. Passing --foo returns Set True, while passing --no-foo returns Set False. Passing neither --foo nor --no-foo returns Unset.

TODO: This doesn't quite work. If the user passes both --foo and --no-foo flags, this should ideally take the value of the last flag passed. However, it appears that if you pass both flags, the second flag is just not recognized and optparse-applicative raises an error.

Parse and return CliArguments.

Overwrite the arguments in ConfigOptions that have been Set in CliArgs.

>>> import Termonad.Types (defaultConfigOptions)
>>> let cliConfOpts = defaultCliConfigOptions { cliConfScrollbackLen = Set 50 }
>>> let cliArgs = defaultCliArgs { cliConfigOptions = cliConfOpts }
>>> let overwrittenConfOpts = defaultConfigOptions { scrollbackLen = 50 }
>>> applyCliArgs cliArgs defaultConfigOptions == overwrittenConfOpts
True