Categories, payees and tags
Generated from --help output of fob-actual 0.1.0. Every command also accepts the global options --profile <name>, --help and --version.
categories#
categories list#
fob-actual categories list
List categories
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]
--all Include hidden categories [boolean]
categories show#
fob-actual categories show <id>
Show one category by id
Positionals:
id Category id [string] [required]
Options:
--json Output raw JSON [boolean]
categories create#
fob-actual categories create
Create a category
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--name Category name [string] [required]
--group Category group id [string] [required]
--is-income Mark as an income category [boolean]
--hidden Create hidden [boolean]
categories edit#
fob-actual categories edit <id>
Update a category (only passed flags change)
Positionals:
id Category id [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--name Category name [string]
--group Move to this category group id [string]
--hidden Hide or unhide [boolean]
categories delete#
fob-actual categories delete <id>
Delete a category (requires --yes)
Positionals:
id Category id [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--transfer-to Move existing transactions to this category id [string]
-y, --yes Confirm deletion [boolean]
category-groups#
category-groups list#
fob-actual category-groups list
List category groups
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]
--all Include hidden groups [boolean]
category-groups show#
fob-actual category-groups show <id>
Show one category group and its categories
Positionals:
id Category group id [string] [required]
Options:
--json Output raw JSON [boolean]
category-groups create#
fob-actual category-groups create
Create a category group
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--name Group name [string] [required]
--is-income Mark as an income group [boolean]
category-groups edit#
fob-actual category-groups edit <id>
Update a category group (only passed flags change)
Positionals:
id Category group id [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--name Group name [string]
--hidden Hide or unhide [boolean]
category-groups delete#
fob-actual category-groups delete <id>
Delete a category group (requires --yes)
Positionals:
id Category group id [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--transfer-to Move transactions to this category id [string]
-y, --yes Confirm deletion [boolean]
payees#
payees list#
fob-actual payees list
List payees
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]
--common Only frequently-used payees [boolean]
payees show#
fob-actual payees show <id>
Show one payee and its rules
Positionals:
id Payee id [string] [required]
Options:
--json Output raw JSON [boolean]
payees create#
fob-actual payees create
Create a payee
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--name Payee name [string] [required]
payees edit#
fob-actual payees edit <id>
Update a payee (only passed flags change)
Positionals:
id Payee id [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--name Payee name [string]
--favorite Mark as a favorite [boolean]
payees delete#
fob-actual payees delete <id>
Delete a payee (requires --yes)
Positionals:
id Payee id [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
-y, --yes Confirm deletion [boolean]
payees merge#
fob-actual payees merge <id>
Merge other payees into this one (requires --yes)
Positionals:
id Payee id to keep [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--from Payee id to merge in (repeatable) [array] [required]
-y, --yes Confirm the merge [boolean]
tags#
tags list#
fob-actual tags list
List tags
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]
tags show#
fob-actual tags show <id>
Show one tag
Positionals:
id Tag id [string] [required]
Options:
--json Output raw JSON [boolean]
tags create#
fob-actual tags create
Create a tag
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--tag Tag text [string] [required]
--color Colour, e.g. #ff0000 [string]
--description Description [string]
tags edit#
fob-actual tags edit <id>
Update a tag (only passed flags change)
Positionals:
id Tag id [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
--tag Tag text [string]
--color Colour, e.g. #ff0000 [string]
--description Description [string]
tags delete#
fob-actual tags delete <id>
Delete a tag (requires --yes)
Positionals:
id Tag id [string] [required]
Options:
--dry-run Show what would change without writing [boolean]
--json Output raw JSON [boolean]
-y, --yes Confirm deletion [boolean]