Skip to main content

Costflow CLI


npm install -g costflow-cli



All the input should follow Costflow Syntax.


Your config file will be generated when you run costflow first time, the name is .costflow.json and located in your home directory. Your should update it before you start.

The config fields are same as Costflow Syntax, except a new field name filePath. The filePath is the ledger file path you want Costflow CLI to save the output.

The filePath can contain a dynamic date format, the dynamic part should between two %. Here are some variable you can use.

YYTwo-digit year19
YYYYFour-digit year2019
MThe month, beginning at 11-12
MMThe month, 2-digits01-12
MMMThe abbreviated month nameJan-Dec
MMMMThe full month nameJanuary-December
DThe day of the month1-31
DDThe day of the month, 2-digits01-31

For example, if the filePath is /Users/leplay/beancount/%YYYY/MM%.bean and the posting date is 2019-09-18, the output will be saved to /Users/leplay/beancount/2019/09.bean.

Open Source