The Centjes CLI

Documentation about the Centjes CLI

Reference

Options

  --config-file Path to the configuration file
  check perform an internal consistency check
  register register report
      --convert      Currency to convert to                                             
      --individually All transactions in one block                                      
      --daily        Group transactions by day                                          
      --weekly       Group transactions by week                                         
      --monthly      Group transactions by month                                        
      --quarterly    Group transactions by quarter                                      
      --yearly       Group transactions by year                                         
      --block        Group transactions                     default: BlockSizeIndividual
      --virtual      Show virtual postings too              default: False              
      --year         Balance at the end of the given year                               
      --this-year    Balance at the end of the current year                             
      --last-year    Balance at the end of last year                                    
      FILTER         filter                                                             
      FILTER         filter                                                             
  balance balance report
      --convert    Currency to convert to                                            
      --show-empty Show empty balances instead of hiding them default: DoNotShowEmpty
      --virtual    Show virtual postings too                  default: False         
      --year       Balance at the end of the given year                              
      --this-year  Balance at the end of the current year                            
      --last-year  Balance at the end of last year                                   
      FILTER       filter                                                            
      FILTER       filter                                                            
  format format files
      -f|--file      File to format     
      -d|--directory Directory to format
  rates-graph graph exchange rates
  -l|--ledger ledger file default: "ledger.cent"
  --watch|-w Run centjes in a loop default: False
  --log-level Minimal severity of log messages default: LevelInfo example: Info

Environment variables

  CENTJES_CONFIG_FILE FILE_PATH   Path to the configuration file                                               
  CENTJES_YEAR YEAR               Balance at the end of the given year                                         
  CENTJES_YEAR YEAR               Balance at the end of the given year                                         
  CENTJES_LEDGER FILE_PATH        ledger file                            default: "ledger.cent"                
  CENTJES_WATCH ANY               Run centjes in a loop                  default: False                        
  CENTJES_LOG_LEVEL LOG_LEVEL     Minimal severity of log messages       default: LevelInfo       example: Info

Configuration values

  Currency to convert to
  register.convert:
    # or null
    <string>
  Group transactions
  default: BlockSizeIndividual
  register.block:
    # or null
    <string>
  Show virtual postings too
  default: False
  register.virtual:
    # or null
    <boolean>
  Balance at the end of the given year
  register.year:
    # or null
    <integer>
  filter
  register.filter:
    # or null
    def: Filter
    # any of
    [ <string>
    , - ref: Filter
    ]
  Currency to convert to
  balance.convert:
    # or null
    <string>
  Show empty balances instead of hiding them
  default: DoNotShowEmpty
  balance.show-empty:
    # or null
    <boolean>
  Show virtual postings too
  default: False
  balance.virtual:
    # or null
    <boolean>
  Balance at the end of the given year
  balance.year:
    # or null
    <integer>
  filter
  balance.filter:
    # or null
    def: Filter
    # any of
    [ <string>
    , - ref: Filter
    ]
  ledger file
  default: "ledger.cent"
  ledger:
    # or null
    <string>
  Run centjes in a loop
  default: False
  watch:
    # or null
    <boolean>
  Minimal severity of log messages
  default: LevelInfo
  example: Info
  log-level:
    # or null
    # one of
    [ Debug
    , Info
    , Warn
    , Error
    ]

Combined settings

Usage: centjes [--config-file FILE_PATH] COMMAND [-l|--ledger FILE_PATH] [--watch|-w --watch|-w ANY] [--log-level LOG_LEVEL]

All settings:
  Show this help text
  switch: -h|--help

  Output version information
  switch: --version

  Path to the configuration file
  option: --config-file FILE_PATH
  env: CENTJES_CONFIG_FILE FILE_PATH

  ledger file
  option: -l|--ledger FILE_PATH
  env: CENTJES_LEDGER FILE_PATH
  config:
    ledger: # or null
      <string>
  default: "ledger.cent"

  Run centjes in a loop
  switch: --watch|-w
  option: --watch|-w ANY
  env: CENTJES_WATCH ANY
  config:
    watch: # or null
      <boolean>
  default: False

  Minimal severity of log messages
  option: --log-level LOG_LEVEL
  env: CENTJES_LOG_LEVEL LOG_LEVEL
  config:
    log-level: # or null
      # one of
      [ Debug
      , Info
      , Warn
      , Error
      ]
  default: LevelInfo
  example: Info

All commands:
  perform an internal consistency check
  command: check
  
  register report
  command: register
    Currency to convert to
    option: --convert CURRENCY
    config:
      register.convert: # or null
        <string>
    
    All transactions in one block
    switch: --individually
  
    Group transactions by day
    switch: --daily
  
    Group transactions by week
    switch: --weekly
  
    Group transactions by month
    switch: --monthly
  
    Group transactions by quarter
    switch: --quarterly
  
    Group transactions by year
    switch: --yearly
  
    Group transactions
    option: --block BLOCK_SIZE
    config:
      register.block: # or null
        <string>
    default: BlockSizeIndividual
    
    Show virtual postings too
    switch: --virtual
    config:
      register.virtual: # or null
        <boolean>
    default: False
    
    Balance at the end of the given year
    option: --year YEAR
    env: CENTJES_YEAR YEAR
    config:
      register.year: # or null
        <integer>
  
    Balance at the end of the current year
    switch: --this-year
  
    Balance at the end of last year
    switch: --last-year
    
    filter
    argument: FILTER
    
    filter
    argument: FILTER
    
    filter
    config:
      register.filter: # or null
        def: Filter
        # any of
        [ <string>
        , - ref: Filter
        ]
    
  
  balance report
  command: balance
    Currency to convert to
    option: --convert CURRENCY
    config:
      balance.convert: # or null
        <string>
    
    Show empty balances instead of hiding them
    switch: --show-empty
    config:
      balance.show-empty: # or null
        <boolean>
    default: DoNotShowEmpty
    
    Show virtual postings too
    switch: --virtual
    config:
      balance.virtual: # or null
        <boolean>
    default: False
    
    Balance at the end of the given year
    option: --year YEAR
    env: CENTJES_YEAR YEAR
    config:
      balance.year: # or null
        <integer>
  
    Balance at the end of the current year
    switch: --this-year
  
    Balance at the end of last year
    switch: --last-year
    
    filter
    argument: FILTER
    
    filter
    argument: FILTER
    
    filter
    config:
      balance.filter: # or null
        def: Filter
        # any of
        [ <string>
        , - ref: Filter
        ]
    
  
  format files
  command: format
    File to format
    option: -f|--file FILE_PATH
  
    Directory to format
    option: -d|--directory DIRECTORY_PATH
    
  
  graph exchange rates
  command: rates-graph
  

Options:
  -h|--help Show this help text
  --version Output version information
  --config-file Path to the configuration file
  check perform an internal consistency check
  register register report
      --convert      Currency to convert to                                             
      --individually All transactions in one block                                      
      --daily        Group transactions by day                                          
      --weekly       Group transactions by week                                         
      --monthly      Group transactions by month                                        
      --quarterly    Group transactions by quarter                                      
      --yearly       Group transactions by year                                         
      --block        Group transactions                     default: BlockSizeIndividual
      --virtual      Show virtual postings too              default: False              
      --year         Balance at the end of the given year                               
      --this-year    Balance at the end of the current year                             
      --last-year    Balance at the end of last year                                    
      FILTER         filter                                                             
      FILTER         filter                                                             
  balance balance report
      --convert    Currency to convert to                                            
      --show-empty Show empty balances instead of hiding them default: DoNotShowEmpty
      --virtual    Show virtual postings too                  default: False         
      --year       Balance at the end of the given year                              
      --this-year  Balance at the end of the current year                            
      --last-year  Balance at the end of last year                                   
      FILTER       filter                                                            
      FILTER       filter                                                            
  format format files
      -f|--file      File to format     
      -d|--directory Directory to format
  rates-graph graph exchange rates
  -l|--ledger ledger file default: "ledger.cent"
  --watch|-w Run centjes in a loop default: False
  --log-level Minimal severity of log messages default: LevelInfo example: Info

Environment Variables:
  CENTJES_CONFIG_FILE FILE_PATH   Path to the configuration file                                               
  CENTJES_YEAR YEAR               Balance at the end of the given year                                         
  CENTJES_YEAR YEAR               Balance at the end of the given year                                         
  CENTJES_LEDGER FILE_PATH        ledger file                            default: "ledger.cent"                
  CENTJES_WATCH ANY               Run centjes in a loop                  default: False                        
  CENTJES_LOG_LEVEL LOG_LEVEL     Minimal severity of log messages       default: LevelInfo       example: Info

Configuration Values:
  Currency to convert to
  register.convert:
    # or null
    <string>
  Group transactions
  default: BlockSizeIndividual
  register.block:
    # or null
    <string>
  Show virtual postings too
  default: False
  register.virtual:
    # or null
    <boolean>
  Balance at the end of the given year
  register.year:
    # or null
    <integer>
  filter
  register.filter:
    # or null
    def: Filter
    # any of
    [ <string>
    , - ref: Filter
    ]
  Currency to convert to
  balance.convert:
    # or null
    <string>
  Show empty balances instead of hiding them
  default: DoNotShowEmpty
  balance.show-empty:
    # or null
    <boolean>
  Show virtual postings too
  default: False
  balance.virtual:
    # or null
    <boolean>
  Balance at the end of the given year
  balance.year:
    # or null
    <integer>
  filter
  balance.filter:
    # or null
    def: Filter
    # any of
    [ <string>
    , - ref: Filter
    ]
  ledger file
  default: "ledger.cent"
  ledger:
    # or null
    <string>
  Run centjes in a loop
  default: False
  watch:
    # or null
    <boolean>
  Minimal severity of log messages
  default: LevelInfo
  example: Info
  log-level:
    # or null
    # one of
    [ Debug
    , Info
    , Warn
    , Error
    ]