1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
# firefly-cli
A command-line tool that lets an LLM agent (and you) interact with a
[Firefly III](https://www.firefly-iii.org/) instance over its REST API.
Python package, stdlib only, exposing the `firefly` command.
## Install
```bash
pip install -e .
```
Requires Python 3.11 or newer. No third-party runtime dependencies.
## Configuration
Provide your Firefly III URL and a personal access token in either way:
- Run `firefly auth set` and follow the prompts (stored in a local TOML file).
- Or set environment variables `FIREFLY_URL` and `FIREFLY_TOKEN`, which take
precedence over the config file.
## Commands
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`.
## For agents (skill)
[`SKILL.md`](SKILL.md) is an agent-operating guide for driving `firefly`: the
JSON/exit-code contract, name resolution, transaction-type inference, task
recipes, and gotchas. It carries skill frontmatter, so it can be symlinked into
a Claude Code skills directory to auto-activate on Firefly III and personal
finance tasks.
## License
Released under the GNU General Public License, version 2 only (GPLv2-only).
See the [LICENSE](LICENSE) file for the full text.
|
