Budgets

Generated from --help output of fob-actual 0.1.0. Every command also accepts the global options --profile <name>, --help and --version.

budgets#

budgets list#

fob-actual budgets list

List budget files on the server

Options:
      --limit   Maximum rows to show                                                        [number]
      --json    Output raw JSON                                                            [boolean]
      --fields  Columns to show, comma-separated                                            [string]
      --format  Output format                             [string] [choices: "table", "csv", "json"]
      --output  Write output to a file instead of stdout                                    [string]

budgets show#

fob-actual budgets show <id>

Show one budget file by sync id or name

Positionals:
  id  Sync id, file id, or budget name                                           [string] [required]

Options:
      --json  Output raw JSON                                                              [boolean]

budgets sync#

fob-actual budgets sync

Sync the bound budget with the server

Options:
      --json  Output raw JSON                                                              [boolean]

budgets months#

fob-actual budgets months

List the months this budget covers

Options:
      --json  Output raw JSON                                                              [boolean]

budgets month#

fob-actual budgets month <month>

Show one month's budget by category (YYYY-MM)

Positionals:
  month  Month, YYYY-MM                                                          [string] [required]

Options:
      --json  Output raw JSON                                                              [boolean]

budgets set-amount#

fob-actual budgets set-amount <month> <category-id>

Set the budgeted amount for a category in a month

Positionals:
  month        Month, YYYY-MM                                                    [string] [required]
  category-id  Category id                                                       [string] [required]

Options:
      --dry-run  Show what would change without writing                                    [boolean]
      --json     Output raw JSON                                                           [boolean]
      --amount   Amount, e.g. 1250.00                                            [string] [required]

budgets carryover#

fob-actual budgets carryover <month> <category-id>

Roll a category's leftover balance into next month

Positionals:
  month        Month, YYYY-MM                                                    [string] [required]
  category-id  Category id                                                       [string] [required]

Options:
      --dry-run  Show what would change without writing                                    [boolean]
      --json     Output raw JSON                                                           [boolean]
      --off      Turn carryover off instead of on                                          [boolean]

budgets hold#

fob-actual budgets hold <month>

Hold part of a month's leftover funds for next month

Positionals:
  month  Month, YYYY-MM                                                          [string] [required]

Options:
      --dry-run  Show what would change without writing                                    [boolean]
      --json     Output raw JSON                                                           [boolean]
      --amount   Amount to hold, e.g. 500.00                                     [string] [required]

budgets reset-hold#

fob-actual budgets reset-hold <month>

Release a hold previously set on a month

Positionals:
  month  Month, YYYY-MM                                                          [string] [required]

Options:
      --dry-run  Show what would change without writing                                    [boolean]
      --json     Output raw JSON                                                           [boolean]