Home

QUpdateTool wiki

A universal auto-updater for desktop applications, written in Python and PySide6. Start here.

New to QUpdateTool?

• README - what it does, quick start, full CLI/config.yaml reference
• DEV_GUIDE - integrate it into your app: brand file, local build, CI/CD, calling it, exit codes

Features and how they work

• BACKENDS - GitHub, GitHub Enterprise, Gitea, Forgejo, GitLab, or a plain JSON manifest as the release source
• PLATFORMS - artifact selection, installers per OS, silent vs. interactive installs, elevation, stopping/relaunching the app
• RELEASE_NOTES - where "what's new" text comes from
• GUI - the optional Qt progress window and how it's branded

Security

• SECURITY.md - the threat model: what's defended against, what isn't, and why. Includes the pre-release checklist for a new consuming application. Kept in the main repo (not the wiki) so GitHub's Security tab picks it up.

Reference files

• examples/config.yaml - every runtime setting, fully commented
• examples/qsnippet-brand.yaml - a complete, real brand file

Map of the code

If you're changing QUpdateTool itself rather than integrating it, the README layout section lists what each module does.