HORIZON HASKELLDocslts/ghc-10.0.x8c2f8e82026-10-19Search names, modules, packages, or :: a typeCtrl K

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8c2f8e8 · 2026-10-19

Modulehledger-1.52.4GHC2021

Hledger.Cli.Conf

Read extra CLI arguments from a hledger config file.

  • 2 types
  • 10 values
  • Packagehledger-1.52.4
  • Exports12
  • LanguageGHC2021
  • LicenceGPL-3.0-or-later
  • SourceConf.hs
datadata Conf
#

A hledger config file.

Instances2Eq, Show
  • Eq ConfDefined in hledger-1.52.4 · Hledger.Cli.Conf
  • Show ConfDefined in hledger-1.52.4 · Hledger.Cli.Conf
typetype SectionName = String
#

The name of a config file section, with surrounding brackets and whitespace removed.

valuegetConf :: RawOpts -> IO (Either String (Conf, Maybe FilePath))
#

Try to read a hledger config from a config file specified by --conf, or the first config file found in any of several default file paths. If --no-conf was used, or if no file was specified or found, this returns a null Conf. If a specified file, or the first file found, can not be read or parsed, this returns an error message. Otherwise this returns the parsed Conf, and the file path.

valueconfLookup :: SectionName -> Conf -> [Arg]
#

Fetch all the arguments/options defined in a section with this name, if it exists. This should be "general" for the unnamed first section, or a hledger command name.

valueactiveLocalConfFile :: IO (Maybe FilePath)
#

Get the highest precedence local config file: a config file in the current directory or above, that is not a user-wide config file.

valueactiveUserConfFile :: IO (Maybe FilePath)
#

Get the highest precedence user-wide config file, based on the current directory. (This may not be the active config file.)

valueconfFiles :: IO [FilePath]
#

Get the possibleConfFiles which exist, based on the current directory.