Safe Haskell	None
Language	Haskell2010

Hledger.Cli.Main

Description

hledger is a partial haskell clone of John Wiegley's "ledger". It generates ledger-compatible register & balance reports from a plain text journal, and demonstrates a functional implementation of ledger. For more information, see http://hledger.org .

This module provides the main function for the hledger command-line executable. It is exposed here so that it can be imported by eg benchmark scripts.

You can use the command line:

$ hledger --help

or ghci:

$ ghci hledger
> j <- readJournalFile def "examples/sample.journal"
> register [] ["income","expenses"] j
2008/01/01 income               income:salary                   $-1          $-1
2008/06/01 gift                 income:gifts                    $-1          $-2
2008/06/03 eat & shop           expenses:food                    $1          $-1
                                expenses:supplies                $1            0
> balance [Depth "1"] [] l
                 $-1  assets
                  $2  expenses
                 $-2  income
                  $1  liabilities
> l <- myLedger

See Hledger.Data.Ledger for more examples.

Synopsis

mainmode :: [Name] -> Mode RawOpts
main :: IO ()
argsToCliOpts :: [String] -> [String] -> IO CliOpts
moveFlagsAfterCommand :: [String] -> [String]
isMovableNoArgFlag :: [Char] -> Bool
isMovableReqArgFlag :: [Char] -> Bool
isMovableReqArgFlagAndValue :: [Char] -> Bool
isValue :: [Char] -> Bool
flagstomove :: [Flag RawOpts]
noargflagstomove :: [Name]
reqargflagstomove :: [Name]

Documentation

mainmode :: [Name] -> Mode RawOpts Source #

The overall cmdargs mode describing hledger's command-line options and subcommands.

main :: IO () Source #

Let's go!

argsToCliOpts :: [String] -> [String] -> IO CliOpts Source #

Parse hledger CLI options from these command line arguments and add-on command names, or raise any error.

moveFlagsAfterCommand :: [String] -> [String] Source #

A hacky workaround for cmdargs not accepting flags before the subcommand name: try to detect and move such flags after the command. This allows the user to put them in either position. The order of options is not preserved, but this should be ok.

Since we're not parsing flags as precisely as cmdargs here, this is imperfect. We make a decent effort to: - move all no-argument helpinputreport flags - move all required-argument helpinputreport flags along with their values, space-separated or not - not confuse things further or cause misleading errors.

isMovableNoArgFlag :: [Char] -> Bool Source #

isMovableReqArgFlag :: [Char] -> Bool Source #

isMovableReqArgFlagAndValue :: [Char] -> Bool Source #

isValue :: [Char] -> Bool Source #

flagstomove :: [Flag RawOpts] Source #

noargflagstomove :: [Name] Source #

reqargflagstomove :: [Name] Source #