From 8dac1b75de09c034cae659b5ce787ef9a072314c Mon Sep 17 00:00:00 2001 From: "Danilo M." Date: Fri, 3 Jul 2026 18:22:11 +0200 Subject: docs: sync README command list to registry (budget group, tx edit/delete, --budget, v0.4.1) --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cf4eb4d..48be94a 100644 --- a/README.md +++ b/README.md @@ -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 --type asset|expense|revenue firefly tx add --from --to [--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 show one transaction -firefly tx search search transactions +firefly tx search search transactions by Firefly query string +firefly tx edit [--amount N] [--date D] [--desc T] [--from A] + [--to A] [--category C] [--tags a,b] [--type T] +firefly tx delete --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 [--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 mark a budget active +firefly budget disable mark a budget inactive +firefly budget delete --yes +firefly budget limit-list +firefly budget limit-set --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) -- cgit v1.2.3