Configuration
To make the syntax easier, users will be asked to fill the following fields to config:
| Config | Required | Type | Detail | Example |
|---|---|---|---|---|
| mode | Y | String | Output format, only support beancount in this version。 | beancount |
| currency | Y | String | Default currency code, in ISO 4217 format。 | CNY |
| timezone | N | String | Timezone, in IANA format。 | Asia/Hong_Kong |
| indent | N | Number | Indent length, for transaction commands. | 2 |
| lineLength | N | Number | The length before currency code(include), for transaction commands. | 80 |
| tag | N | String | Apply tag(s) to every transaction automatically. Start with #, separated with blank space if multiple. | #trip #food |
| link | N | String | Apply link(s) to every transaction automatically. Start with ^, separated with blank space if multiple. | ^project-x |
| insertTime | N | String | Insert time to every transaction, the value is the position to insert. Currently only metadata allowed. | metadata |
| alphavantage | N | String | If you want to use pricing or \$ command, you should apply your own Alpha Vantage API token.. | TRBZ2Y1D7TN0ZHFO |
| account | N | Object | Use key: value format. Replacing the key with the value of your input. The value is the account name in your legder file. | {"bofa": "Assets:US:BofA:Checking"} |
| formula | N | Object | Use key: value format. Formula will parse the input first and run Costflow Syntax again. The key is the formula keyword, some variables can be used in the value. Check formula docs. | {"gcp": "@Google {{ amount }} USD visa > cloud"} |
Here is the config will be used in following examples.