diff options
| -rw-r--r-- | README.md | 26 |
1 files changed, 23 insertions, 3 deletions
@@ -42,7 +42,7 @@ Provide your Firefly III URL and a personal access token in either way: ## Commands -Run `firefly --help` for the full list. Current commands: +Run `firefly --help` for the full list. Current commands (v0.4.1): ``` firefly auth set write URL and token to the config file @@ -56,9 +56,26 @@ firefly account create <name> --type asset|expense|revenue firefly tx add <amount> --from <acct> --to <acct> [--desc T] [--date YYYY-MM-DD] [--category C] [--tags a,b] [--type T] + [--budget B] firefly tx list [--since D] [--until D] [--account A] [--limit N] firefly tx get <id> show one transaction -firefly tx search <query> search transactions +firefly tx search <query> search transactions by Firefly query string +firefly tx edit <id> [--amount N] [--date D] [--desc T] [--from A] + [--to A] [--category C] [--tags a,b] [--type T] +firefly tx delete <id> --yes delete one transaction (requires --yes) + +firefly budget list [--start D] [--end D] + list budgets with spent for a period (default: current month) +firefly budget create <name> [--active|--inactive] [--currency CODE] + [--auto-budget-amount N] + [--auto-budget-period daily|weekly|monthly|quarterly|half_year|yearly] + [--auto-budget-type reset|rollover|adjusted|none] +firefly budget enable <name|id> mark a budget active +firefly budget disable <name|id> mark a budget inactive +firefly budget delete <name|id> --yes +firefly budget limit-list <name|id> +firefly budget limit-set <name|id> --amount N [--start D] [--end D] + [--currency CODE] firefly category list firefly tag list @@ -78,7 +95,10 @@ The command set grows over time; see `CLAUDE.md` for how to add one. auto-created; use `account create`. - `tx add` infers the transaction type from the account types (asset to expense is a withdrawal, revenue to asset is a deposit, asset to asset is a transfer). - Override with `--type`. + Override with `--type`. `tx edit` changes only the fields you pass. +- Budgets are managed by name or id. `budget list` reports spent per budget for + a period; `budget limit-set` sets a spending limit over a date range. + `budget delete` and `tx delete` require `--yes`. ## For agents (skill) |