--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 Filter to the given year
--this-year Filter to the current year
--last-year Filter to last year (beginning to end of last year)
--past-year Filter to the past year (past 365 days)
--this-quarter Filter to the current quarter
--last-quarter Filter to last quarter (beginning to end of last quarter)
--past-quarter Filter to the past quarter (past 90 days)
--this-month Filter to the current month
--last-month Filter to last month (beginning to end of last month)
--past-month Filter to the past month (past 30 days)
--this-week Filter to the current week
--last-week Filter to last week (beginning to end of last week)
--past-week Filter to the past week (past 7 days)
--begin|-b Begin date (inclusive), in YYYY-MM-DD format
--end|-e End date (inclusive), in YYYY-MM-DD format
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
--past-year Balance at the end of the past year (today)
--this-quarter Balance at the end of the current quarter
--last-quarter Balance at the end of last quarter
--past-quarter Balance at the end of the past quarter (today)
--this-month Balance at the end of the current month
--last-month Balance at the end of last month
--past-month Balance at the end of the past month (today)
--this-week Balance at the end of the current week
--last-week Balance at the end of last week
--past-week Balance at the end of the past week (today)
--end|-e End date (inclusive), in YYYY-MM-DD format
FILTER filter
FILTER filter
net-worth net worth report
--convert Currency to convert to
--csv Output as CSV default: OutputFormatTerminal
--year Filter to the given year
--this-year Filter to the current year
--last-year Filter to last year (beginning to end of last year)
--past-year Filter to the past year (past 365 days)
--this-quarter Filter to the current quarter
--last-quarter Filter to last quarter (beginning to end of last quarter)
--past-quarter Filter to the past quarter (past 90 days)
--this-month Filter to the current month
--last-month Filter to last month (beginning to end of last month)
--past-month Filter to the past month (past 30 days)
--this-week Filter to the current week
--last-week Filter to last week (beginning to end of last week)
--past-week Filter to the past week (past 7 days)
--begin|-b Begin date (inclusive), in YYYY-MM-DD format
--end|-e End date (inclusive), in YYYY-MM-DD format
income-statement income statement 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 Filter to the given year
--this-year Filter to the current year
--last-year Filter to last year (beginning to end of last year)
--past-year Filter to the past year (past 365 days)
--this-quarter Filter to the current quarter
--last-quarter Filter to last quarter (beginning to end of last quarter)
--past-quarter Filter to the past quarter (past 90 days)
--this-month Filter to the current month
--last-month Filter to last month (beginning to end of last month)
--past-month Filter to the past month (past 30 days)
--this-week Filter to the current week
--last-week Filter to last week (beginning to end of last week)
--past-week Filter to the past week (past 7 days)
--begin|-b Begin date (inclusive), in YYYY-MM-DD format
--end|-e End date (inclusive), in YYYY-MM-DD format
FILTER filter
FILTER filter
format format files
-f|--file File to format
-d|--directory Directory to format
rates-graph graph exchange rates
-o|--output Output file (default: stdout)
-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
CENTJES_CONFIG_FILE FILE_PATH Path to the configuration file
CENTJES_YEAR YEAR Filter to the given year
CENTJES_YEAR YEAR Balance at the end of the given year
CENTJES_YEAR YEAR Filter to the given year
CENTJES_YEAR YEAR Filter to 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
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>
Filter to the given year
register.year:
# or null
<integer>
Begin date (inclusive), in YYYY-MM-DD format
register.begin:
# or null
# Day
<string>
End date (inclusive), in YYYY-MM-DD format
register.end:
# or null
# Day
<string>
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
]
Currency to convert to
net-worth.convert:
# or null
<string>
Filter to the given year
net-worth.year:
# or null
<integer>
Begin date (inclusive), in YYYY-MM-DD format
net-worth.begin:
# or null
# Day
<string>
End date (inclusive), in YYYY-MM-DD format
net-worth.end:
# or null
# Day
<string>
Currency to convert to
income-statement.convert:
# or null
<string>
Show empty balances instead of hiding them
default: DoNotShowEmpty
income-statement.show-empty:
# or null
<boolean>
Show virtual postings too
default: False
income-statement.virtual:
# or null
<boolean>
Filter to the given year
income-statement.year:
# or null
<integer>
Begin date (inclusive), in YYYY-MM-DD format
income-statement.begin:
# or null
# Day
<string>
End date (inclusive), in YYYY-MM-DD format
income-statement.end:
# or null
# Day
<string>
filter
income-statement.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
]
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
Filter to the given year
option: --year YEAR
env: CENTJES_YEAR YEAR
config:
register.year: # or null
<integer>
Filter to the current year
switch: --this-year
Filter to last year (beginning to end of last year)
switch: --last-year
Filter to the past year (past 365 days)
switch: --past-year
Filter to the current quarter
switch: --this-quarter
Filter to last quarter (beginning to end of last quarter)
switch: --last-quarter
Filter to the past quarter (past 90 days)
switch: --past-quarter
Filter to the current month
switch: --this-month
Filter to last month (beginning to end of last month)
switch: --last-month
Filter to the past month (past 30 days)
switch: --past-month
Filter to the current week
switch: --this-week
Filter to last week (beginning to end of last week)
switch: --last-week
Filter to the past week (past 7 days)
switch: --past-week
Begin date (inclusive), in YYYY-MM-DD format
option: --begin|-b DATE
config:
register.begin: # or null
# Day
<string>
End date (inclusive), in YYYY-MM-DD format
option: --end|-e DATE
config:
register.end: # or null
# Day
<string>
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
Balance at the end of the past year (today)
switch: --past-year
Balance at the end of the current quarter
switch: --this-quarter
Balance at the end of last quarter
switch: --last-quarter
Balance at the end of the past quarter (today)
switch: --past-quarter
Balance at the end of the current month
switch: --this-month
Balance at the end of last month
switch: --last-month
Balance at the end of the past month (today)
switch: --past-month
Balance at the end of the current week
switch: --this-week
Balance at the end of last week
switch: --last-week
Balance at the end of the past week (today)
switch: --past-week
End date (inclusive), in YYYY-MM-DD format
option: --end|-e DATE
filter
argument: FILTER
filter
argument: FILTER
filter
config:
balance.filter: # or null
def: Filter
# any of
[ <string>
, - ref: Filter
]
net worth report
command: net-worth
Currency to convert to
option: --convert CURRENCY
config:
net-worth.convert: # or null
<string>
Output as CSV
switch: --csv
default: OutputFormatTerminal
Filter to the given year
option: --year YEAR
env: CENTJES_YEAR YEAR
config:
net-worth.year: # or null
<integer>
Filter to the current year
switch: --this-year
Filter to last year (beginning to end of last year)
switch: --last-year
Filter to the past year (past 365 days)
switch: --past-year
Filter to the current quarter
switch: --this-quarter
Filter to last quarter (beginning to end of last quarter)
switch: --last-quarter
Filter to the past quarter (past 90 days)
switch: --past-quarter
Filter to the current month
switch: --this-month
Filter to last month (beginning to end of last month)
switch: --last-month
Filter to the past month (past 30 days)
switch: --past-month
Filter to the current week
switch: --this-week
Filter to last week (beginning to end of last week)
switch: --last-week
Filter to the past week (past 7 days)
switch: --past-week
Begin date (inclusive), in YYYY-MM-DD format
option: --begin|-b DATE
config:
net-worth.begin: # or null
# Day
<string>
End date (inclusive), in YYYY-MM-DD format
option: --end|-e DATE
config:
net-worth.end: # or null
# Day
<string>
income statement report
command: income-statement
Currency to convert to
option: --convert CURRENCY
config:
income-statement.convert: # or null
<string>
Show empty balances instead of hiding them
switch: --show-empty
config:
income-statement.show-empty: # or null
<boolean>
default: DoNotShowEmpty
Show virtual postings too
switch: --virtual
config:
income-statement.virtual: # or null
<boolean>
default: False
Filter to the given year
option: --year YEAR
env: CENTJES_YEAR YEAR
config:
income-statement.year: # or null
<integer>
Filter to the current year
switch: --this-year
Filter to last year (beginning to end of last year)
switch: --last-year
Filter to the past year (past 365 days)
switch: --past-year
Filter to the current quarter
switch: --this-quarter
Filter to last quarter (beginning to end of last quarter)
switch: --last-quarter
Filter to the past quarter (past 90 days)
switch: --past-quarter
Filter to the current month
switch: --this-month
Filter to last month (beginning to end of last month)
switch: --last-month
Filter to the past month (past 30 days)
switch: --past-month
Filter to the current week
switch: --this-week
Filter to last week (beginning to end of last week)
switch: --last-week
Filter to the past week (past 7 days)
switch: --past-week
Begin date (inclusive), in YYYY-MM-DD format
option: --begin|-b DATE
config:
income-statement.begin: # or null
# Day
<string>
End date (inclusive), in YYYY-MM-DD format
option: --end|-e DATE
config:
income-statement.end: # or null
# Day
<string>
filter
argument: FILTER
filter
argument: FILTER
filter
config:
income-statement.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
Output file (default: stdout)
option: -o|--output FILE_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
--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 Filter to the given year
--this-year Filter to the current year
--last-year Filter to last year (beginning to end of last year)
--past-year Filter to the past year (past 365 days)
--this-quarter Filter to the current quarter
--last-quarter Filter to last quarter (beginning to end of last quarter)
--past-quarter Filter to the past quarter (past 90 days)
--this-month Filter to the current month
--last-month Filter to last month (beginning to end of last month)
--past-month Filter to the past month (past 30 days)
--this-week Filter to the current week
--last-week Filter to last week (beginning to end of last week)
--past-week Filter to the past week (past 7 days)
--begin|-b Begin date (inclusive), in YYYY-MM-DD format
--end|-e End date (inclusive), in YYYY-MM-DD format
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
--past-year Balance at the end of the past year (today)
--this-quarter Balance at the end of the current quarter
--last-quarter Balance at the end of last quarter
--past-quarter Balance at the end of the past quarter (today)
--this-month Balance at the end of the current month
--last-month Balance at the end of last month
--past-month Balance at the end of the past month (today)
--this-week Balance at the end of the current week
--last-week Balance at the end of last week
--past-week Balance at the end of the past week (today)
--end|-e End date (inclusive), in YYYY-MM-DD format
FILTER filter
FILTER filter
net-worth net worth report
--convert Currency to convert to
--csv Output as CSV default: OutputFormatTerminal
--year Filter to the given year
--this-year Filter to the current year
--last-year Filter to last year (beginning to end of last year)
--past-year Filter to the past year (past 365 days)
--this-quarter Filter to the current quarter
--last-quarter Filter to last quarter (beginning to end of last quarter)
--past-quarter Filter to the past quarter (past 90 days)
--this-month Filter to the current month
--last-month Filter to last month (beginning to end of last month)
--past-month Filter to the past month (past 30 days)
--this-week Filter to the current week
--last-week Filter to last week (beginning to end of last week)
--past-week Filter to the past week (past 7 days)
--begin|-b Begin date (inclusive), in YYYY-MM-DD format
--end|-e End date (inclusive), in YYYY-MM-DD format
income-statement income statement 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 Filter to the given year
--this-year Filter to the current year
--last-year Filter to last year (beginning to end of last year)
--past-year Filter to the past year (past 365 days)
--this-quarter Filter to the current quarter
--last-quarter Filter to last quarter (beginning to end of last quarter)
--past-quarter Filter to the past quarter (past 90 days)
--this-month Filter to the current month
--last-month Filter to last month (beginning to end of last month)
--past-month Filter to the past month (past 30 days)
--this-week Filter to the current week
--last-week Filter to last week (beginning to end of last week)
--past-week Filter to the past week (past 7 days)
--begin|-b Begin date (inclusive), in YYYY-MM-DD format
--end|-e End date (inclusive), in YYYY-MM-DD format
FILTER filter
FILTER filter
format format files
-f|--file File to format
-d|--directory Directory to format
rates-graph graph exchange rates
-o|--output Output file (default: stdout)
-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 Filter to the given year
CENTJES_YEAR YEAR Balance at the end of the given year
CENTJES_YEAR YEAR Filter to the given year
CENTJES_YEAR YEAR Filter to 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>
Filter to the given year
register.year:
# or null
<integer>
Begin date (inclusive), in YYYY-MM-DD format
register.begin:
# or null
# Day
<string>
End date (inclusive), in YYYY-MM-DD format
register.end:
# or null
# Day
<string>
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
]
Currency to convert to
net-worth.convert:
# or null
<string>
Filter to the given year
net-worth.year:
# or null
<integer>
Begin date (inclusive), in YYYY-MM-DD format
net-worth.begin:
# or null
# Day
<string>
End date (inclusive), in YYYY-MM-DD format
net-worth.end:
# or null
# Day
<string>
Currency to convert to
income-statement.convert:
# or null
<string>
Show empty balances instead of hiding them
default: DoNotShowEmpty
income-statement.show-empty:
# or null
<boolean>
Show virtual postings too
default: False
income-statement.virtual:
# or null
<boolean>
Filter to the given year
income-statement.year:
# or null
<integer>
Begin date (inclusive), in YYYY-MM-DD format
income-statement.begin:
# or null
# Day
<string>
End date (inclusive), in YYYY-MM-DD format
income-statement.end:
# or null
# Day
<string>
filter
income-statement.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
]