diff options
| author | Danilo M. <danix@danix.xyz> | 2026-07-01 12:19:50 +0200 |
|---|---|---|
| committer | Danilo M. <danix@danix.xyz> | 2026-07-01 12:19:50 +0200 |
| commit | 228097e18fdffdc3d8b34d3017dad14267b9acaa (patch) | |
| tree | 58e81473df5422eab25948800c8055917b09c703 | |
| parent | 941ccb2cb34944e1321b3dc23731bfa93018d74f (diff) | |
| download | firefly-cli-228097e18fdffdc3d8b34d3017dad14267b9acaa.tar.gz firefly-cli-228097e18fdffdc3d8b34d3017dad14267b9acaa.zip | |
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 <noreply@anthropic.com>
| -rw-r--r-- | CLAUDE.md | 6 |
1 files changed, 6 insertions, 0 deletions
@@ -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<running-version>`. +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 |