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                               
      --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
  -l|--ledger ledger file default: "ledger.cent"

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"

Configuration values

  Currency to convert to
  register.convert:
    # 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>
  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>
  ledger file
  default: "ledger.cent"
  ledger:
    # or null
    <string>

Combined settings

Usage: centjes [--config-file FILE_PATH] COMMAND [-l|--ledger FILE_PATH]

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"

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>
    
    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
    
  
  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
    
  
  format files
  command: format
    File to format
    option: -f|--file FILE_PATH
  
    Directory to format
    option: -d|--directory DIRECTORY_PATH
    
  

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                               
      --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
  -l|--ledger ledger file default: "ledger.cent"

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"

Configuration Values:
  Currency to convert to
  register.convert:
    # 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>
  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>
  ledger file
  default: "ledger.cent"
  ledger:
    # or null
    <string>