Civitai Companion for Windows
A small desktop app that keeps an eye on your Civitai account, so you don't need the website open.
Version 1.0.25 · Windows 10/11 x64
[Download the latest release](https://github.com/Tar-Tarj/Civitai-companion/releases/latest) · [Source code on GitHub](https://github.com/Tar-Tarj/Civitai-companion)
Features
- Account at a glance: avatar, username, Blue / Yellow / Green Buzz balances and new followers today.
- Notifications: comments and replies, followers, reaction milestones, Buzz tips, model updates, collections and more, with filters, previews of images and videos, and mark-as-read.
- Choose what you hear about: switch off any notification group and it is silenced and marked as read for you.
- Windows toasts and sounds: several events at once become one "N new notifications" toast. Pick a different sound for site activity, tips and followers.
- THANKS button: when someone tips Buzz on one of your images or videos, one click posts a comment that mentions them @username) followed by your own message. It is sent once per user and image, so nobody gets thanked twice. You write the message in Settings.
- Buzz ledger: received and spent Buzz for Blue, Yellow and Green, with linked image previews.
- Tray app: keeps syncing in the background, with Show, Sync now and Quit in the tray menu. Optional start with Windows.
- Backup: export and import your preferences.
All links open on civitai.red, the full version of the site.
Download
Get one of these from the [releases page](https://github.com/Tar-Tarj/Civitai-companion/releases/latest):
- Setup (installer): normal installation.
- Portable: a single .exe, no installation needed.
The builds are not code-signed yet, so Microsoft SmartScreen may show a warning. Compare the file with the SHA-256 values in SHA256SUMS.txt on the release page if you want to verify it.
Setup
1. Create an API key at https://civarchive.com/user/account/security .
2. Open the app, go to Settings → Account & Security and choose Configure API key.
3. Paste the key and run Test connection.
API key permissions
| UserRead | Your account, avatar and username |
| BuzzRead | Buzz balances and the ledger |
| NotificationsRead | Notifications and unread count |
| NotificationsWrite | Marking notifications as read |
| MediaRead | Thumbnails in notifications |
| SocialWrite (optional) | The THANKS button, which posts a comment for you |
Without SocialWrite everything else works and the THANKS button stays disabled. To add it later, create a new key with that permission and replace the old one in the app. Settings shows which permissions your key currently has.
Civitai limits comments to roughly 10 per hour. The app only posts when you click THANKS.
Privacy
- Your API key is stored in Windows Credential Manager and never reaches the app interface.
- No telemetry, no analytics, no automatic updater, and no browser or cookie access.
- The app talks only to Civitai. Preference backups never contain your API key.
Open source
The full source is public so you can read exactly what it does. If I ever stop maintaining it, anyone can inspect the code or adapt it to future Civitai API changes.
I built this tool because I needed it myself. Feedback is welcome.
Description
Civitai Companion 1.0.28
Windows 10/11 x64.
Fixed
Sync failing with "Civitai returned an unsupported response": Civitai changed the paging cursor of the notification list (it is now
date|id). The app sent it in the old format and the server refused the second page, so every sync failed. Paging now uses the new format.Switching or removing the API key while a sync is running can no longer write the previous account's data back; Buzz transactions of a previous account are no longer shown after an account change, and a failed Buzz request can be retried with "Try again". (Contribution by CerebralDev.)
Faster refresh
Missing thumbnails are looked up in parallel, at most once every 5 minutes per notification and for at most 4 seconds, so they no longer slow down every refresh.
At most 5 notifications of disabled groups are marked read per sync (was 100), stopping at the first failure; a sync is aborted after 30 seconds; manual refreshes within 5 seconds of a successful sync are merged into one.
Security
Updated Vite and the locked Rust network dependencies (rustls, rustls-webpki, webpki-roots, tokio, quinn-proto) to pick up published security fixes. (Contribution by CerebralDev.)
A single app instance only; THANKS opt-in is now also enforced in the backend; API redirects are validated.