aboutsummaryrefslogtreecommitdiffstats
path: root/firefly-cli/README
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-06-30 11:58:58 +0200
committerDanilo M. <danix@danix.xyz>2026-06-30 11:58:58 +0200
commit34126d105d869c6edb29c054672ce53d3396ee28 (patch)
treedeaa35b5bc3a00def710f25c7a8add57538b431d /firefly-cli/README
parent7bf0929fd4e8204f54d3ae576b3f1c5a2d6ab887 (diff)
downloadmy-slackbuilds-34126d105d869c6edb29c054672ce53d3396ee28.tar.gz
my-slackbuilds-34126d105d869c6edb29c054672ce53d3396ee28.zip
firefly-cli: add version 0.1.0
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Diffstat (limited to 'firefly-cli/README')
-rw-r--r--firefly-cli/README15
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.