Update check
Check whether a newer version is available — anonymously, without sending any image or user data.
Summary
The Update check reports when a newer version of the app is available — via the CLI
(--check-update) and as an in-app notice. It only queries anonymous version information from the
app's own server; no image or user data is sent. It builds on the reusable appkit foundation
(per-user state in %AppData%).
When to use it
- You want to know whether there's a more recent version.
- You work with the CLI and want to check the status in a scriptable way.
How it works
The check queries the provider's update feed (a plain JSON file) and compares the version named there with your installed one. Only this anonymous version query is made — no image material, no personal data.
In the app, a subtle notice appears for a newer version; the scriptable route via the CLI is shown in the CLI / Automation section below.
Settings
| Control | Effect |
|---|---|
CLI --check-update |
Checks the feed and outputs whether a newer version exists. |
| In-app notice | Shows in the interface when a newer version is available. |
CLI / Automation
The Update check is primarily a CLI/automation feature — the invocation is also shown in the CLI
overview. It needs no input/output arguments:
clean_sprite_chromakey.py --check-update
The output is update available: <version> (with a download hint if present) or up to date: <version>;
if the feed is unreachable, the answer is conservatively "up to date".
FAQ
Are my images or data sent? No. Only an anonymous version query is made to the app's own server — no image material, no user data.
What happens if the server isn't (yet) reachable? Then the check safely reports "up to date" — the query returns nothing instead of throwing an error. That's deliberate ("safe by design").
Where is the status stored?
In a per-user state under %AppData% (part of the appkit foundation) — e.g. so the notice isn't
shown again on every start.
Limits
- Only a version comparison — no automatic download/installer; the notice links the download at most.
- Requires a reachable feed; without it the answer is conservatively "up to date".
Examples
TODO: Screenshot of the in-app notice / the CLI output not available yet. Create one if needed and place
it under assets/help/update-check/. Don't invent.
Related features
- No directly related feature pages — the Update check is an appkit utility.