From 228097e18fdffdc3d8b34d3017dad14267b9acaa Mon Sep 17 00:00:00 2001 From: "Danilo M." Date: Wed, 1 Jul 2026 12:19:50 +0200 Subject: docs: pin reference firefly-iii checkout to the running instance version Note in CLAUDE.md that ../GITHUB/firefly-iii should track the tag matching the running Firefly instance (currently v6.6.5), refreshed manually after an upgrade, not auto-pulled to master (a newer master can be wrong for this instance's API shapes). Co-Authored-By: Claude Opus 4.8 --- CLAUDE.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'CLAUDE.md') diff --git a/CLAUDE.md b/CLAUDE.md index a89841a..8b7f278 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -7,6 +7,12 @@ instance over its REST API. Python package, command `firefly`. The Firefly III source is cloned at `../GITHUB/firefly-iii/` for reference only (API shapes, transformers, route definitions). NEVER write to it. +Keep it checked out to the tag matching the *running* Firefly instance, not +latest master: API shapes drift between versions and a mismatch means checking +against code the instance doesn't have. After upgrading the instance, refresh +manually: `git -C ../GITHUB/firefly-iii fetch --tags && git -C ../GITHUB/firefly-iii checkout v`. +Do not auto-pull on session start (a newer master can be wrong for this instance). + ## Architecture - `firefly_cli/` package. Shared primitives: `config.py` (env over TOML file), `client.py` (HTTP + auth + error surfacing), `errors.py` (FireflyError -- cgit v1.2.3