aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-06-30 11:18:08 +0200
committerDanilo M. <danix@danix.xyz>2026-06-30 11:18:08 +0200
commit80a0bd54cf601c3ac4f6c28bccb77c9476cd4ece (patch)
treebbd0376221b427357b2e545af4b9508b533f1e38 /README.md
parent97e7aaa381253348a81dcbf298ffd4264dc2f57c (diff)
downloadfirefly-cli-80a0bd54cf601c3ac4f6c28bccb77c9476cd4ece.tar.gz
firefly-cli-80a0bd54cf601c3ac4f6c28bccb77c9476cd4ece.zip
docs: finalize README command reference
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 33 insertions, 2 deletions
diff --git a/README.md b/README.md
index f519bf7..98e7b5e 100644
--- a/README.md
+++ b/README.md
@@ -22,8 +22,39 @@ Provide your Firefly III URL and a personal access token in either way:
## Commands
-Run `firefly --help` to see the available command groups and options. The full
-set of commands is still being built out, so expect more to appear over time.
+Run `firefly --help` for the full list. Current commands:
+
+```
+firefly auth set write URL and token to the config file
+firefly auth test verify connectivity and token
+
+firefly account list [--type T] list accounts (filter: asset, expense, ...)
+firefly account get <name|id> show one account
+firefly account balance <name> show an account balance
+
+firefly tx add <amount> --from <acct> --to <acct> [--desc T]
+ [--date YYYY-MM-DD] [--category C] [--tags a,b] [--type T]
+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 category list
+firefly tag list
+```
+
+The command set grows over time; see `CLAUDE.md` for how to add one.
+
+## For agents
+
+- Output is JSON by default. Pass `--human` for aligned tables.
+- Exit code is 0 on success, 1 on any error; errors print as
+ `{"error": "..."}` on stderr.
+- Account, category, and tag arguments accept names, which are resolved to IDs.
+ An ambiguous or unknown name is a hard error listing the candidates, never a
+ silent guess.
+- `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`.
## License