Command line options, used in the hledger package and above. This is the "opts" used throughout hledger CLI code. representing the options that arguments that were provided at startup on the command-line.

Constructors

CliOpts
Fields rawopts_ :: RawOpts command_ :: String file_ :: Maybe FilePath rules_file_ :: Maybe FilePath alias_ :: [String] debug_ :: Int debug level, set by `--debug[=N]`. See also `debugLevel`. no_new_accounts_ :: Bool width_ :: Maybe String reportopts_ :: ReportOpts

Instances

Data CliOpts
Show CliOpts
Typeable CliOpts
Default CliOpts

defcliopts :: CliOpts Source

getCliOpts :: Mode RawOpts -> IO CliOpts Source

Parse hledger CLI options from the command line using the given cmdargs mode, and either return them or, if a help flag is present, print the mode help and exit the program.

decodeRawOpts :: RawOpts -> RawOpts Source

Convert possibly encoded option values to regular unicode strings.

rawOptsToCliOpts :: RawOpts -> IO CliOpts Source

Parse raw option string values to the desired final data types. Any relative smart dates will be converted to fixed dates based on today's date. Parsing failures will raise an error.

checkCliOpts :: CliOpts -> IO CliOpts Source

Do final validation of processed opts, raising an error if there is trouble.

CLI option accessors

These do the extra processing required for some options.

aliasesFromOpts :: CliOpts -> [(AccountName, AccountName)]Source

Get the account name aliases from options, if any.

journalFilePathFromOpts :: CliOpts -> IO String Source

Get the (tilde-expanded, absolute) journal file path from 1. options, 2. an environment variable, or 3. the default.

rulesFilePathFromOpts :: CliOpts -> IO (Maybe FilePath)Source

Get the (tilde-expanded) rules file path from options, if any.

For register:

data OutputWidth Source

Output width configuration (for register).

Constructors

TotalWidth Width	specify the overall width
FieldWidths [Width]	specify each field's width

Instances

Show OutputWidth

data Width Source

A width value.

Constructors

Width Int	set width to exactly this number of characters
Auto	set width automatically from available space

Instances

Show Width

defaultWidth :: Int Source

Default width of hledger console output.

defaultWidthWithFlag :: Int Source

Width of hledger console output when the -w flag is used with no value.

widthFromOpts :: CliOpts -> Either String OutputWidth Source

Parse the width option if provided, possibly returning an error, otherwise get the default value.

For balance:

formatFromOpts :: ReportOpts -> Either String [OutputFormat]Source

Parse the format option if provided, possibly returning an error, otherwise get the default value.

Other utils

hledgerAddons :: IO ([String], [String])Source

Get the sorted unique precise names and display names of hledger add-ons found in the current user's PATH. The precise names are the add-on's filename with the hledger- prefix removed. The display names have the file extension removed also, except when it's needed for disambiguation.

- Also when there are exactly two similar names, one with the .hs or -- .lhs extension and the other with the .exe extension or no -- extension - presumably source and compiled versions of a haskell -- script - we exclude the source version.

This function can return add-on names which shadow built-in command names, but hledger will ignore these.

Tests

tests_Hledger_Cli_Options :: Test Source