diff options
Diffstat (limited to 'firefly-cli/README')
| -rw-r--r-- | firefly-cli/README | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/firefly-cli/README b/firefly-cli/README new file mode 100644 index 0000000..b4da0e8 --- /dev/null +++ b/firefly-cli/README @@ -0,0 +1,15 @@ +firefly-cli is a command-line tool that lets an LLM agent (and you) +interact with a self-hosted Firefly III instance over its REST API. It +exposes the 'firefly' command, emits JSON by default (pass --human for +tables), and resolves account, category, and tag names to IDs. + +Pure Python, standard library only. No third-party runtime dependencies. +Requires Python 3.11 or newer. + +Configuration: provide your Firefly III URL and a personal access token +either by running 'firefly auth set' (stored in a local TOML file) or by +setting the FIREFLY_URL and FIREFLY_TOKEN environment variables, which +take precedence over the config file. + +A Firefly III instance and a valid personal access token are required at +runtime; they are not build-time dependencies. |