FAQ
Questions people ask.
Is it really free?
Yes. WorkKit Buddy is a free product from WorkKit for anyone on macOS, Windows or Linux. No account, no trial, no upsell inside the app.
What is WorkKit, and where does Buddy fit?
WorkKit is an engineering-intelligence platform for the teams who deliver experience, event, museum and interactive technology: quotations, proposals and bills of quantity built on verified knowledge. Buddy is its free companion for the desktop. The platform itself lives at app.workkit.in (sign in with GitHub; it is early and says so), and the Labs page shows exactly what is finished and what is not.
Does it record my audio or my screen?
No. To dance it measures the loudness and beats of what your computer is playing, live, in memory, and discards the audio immediately. It never records, saves or uploads anything. It doesn't look at your screen at all.
How does it know what song is playing?
On macOS it asks Spotify or Music what they're playing and reads music-site titles from your browser tabs (macOS will ask once per browser). On Windows it uses the system's media-session information — the same thing the volume flyout shows. The title is only shown to you in the menu.
Can I use my own character?
Yes. Right-click the buddy › Character › Use my own image…, or drag a picture onto it. Plain backgrounds are removed automatically and it gets the same animations as the built-in characters. Custom characters are stored in your user folder and survive updates.
It's in the way / I want it somewhere else.
Drag it anywhere; it stays where you drop it. Turn on Ghost mode to let clicks pass through it, use Hide (or the shortcut: ⌃⌥H on Mac, Ctrl+Alt+H on Windows and Linux) to make it vanish, and Quiet hours to stop the chatter in the evening.
How do I connect it to Claude Code or Codex?
Right-click › Claude Code › Connect, or Codex › Connect. Claude Code's hooks go in ~/.claude/settings.json; Codex's go in ~/.codex/hooks.json. Either way a backup is kept next to the file, your own hooks are left alone, and Disconnect removes only ours. The buddy then reacts when the agent is thinking, editing, testing, waiting for you or finished.
One extra step for Codex: it will not run a hook it has not been shown. After connecting, type /hooks inside Codex, review the WorkKit Buddy entry and trust it. Until you do, Codex lists it as needing review and skips it.
Can my scripts talk to it?
Yes — it registers a URL scheme. From a terminal or any tool that can open a link:
macOS: open -g "workkitbuddy://notify?title=Deploy&text=Production%20is%20live&url=https://workkit.in"
Windows: start "" "workkitbuddy://say?text=hello"
Found a bug, or have an idea for a character?
Open an issue on GitHub, or tell us through the WorkKit contact page if you'd rather not have an account. Include your OS version and, if something misbehaves, the log: ~/Library/Logs/WorkkitBuddy.log on Mac, %APPDATA%\WorkkitBuddy\WorkkitBuddy.log on Windows, ~/.config/WorkkitBuddy/WorkkitBuddy.log on Linux.
Does it update itself?
It tells you, it never changes anything behind your back. Once a day it asks GitHub what the newest release is; if yours is older, the pet brings a card with a link to this page and you install it the same way you did the first time. Nothing is downloaded or replaced on its own. Right-click the pet ▸ Updates to check straight away, or to turn the daily look-up off.
Can it answer questions?
Yes, on all three systems since 1.3. Press ⌃⌥A (Ctrl+Alt+A on Windows and Linux), or double-click the buddy, and a small panel opens beside it. Answers come from Claude or Gemini, whichever you pick in the menu, using your own API key — the buddy has no account of its own. The key is stored on your machine and is only ever sent to the service you chose; nothing leaves your computer until you type a question and press Return.
How do meeting alerts work off a calendar?
macOS reads your calendars directly. Windows and Linux have no equivalent an app like this can rely on, so they read a calendar you publish as an .ics link: in Google Calendar it is Settings ▸ your calendar ▸ "Secret address in iCal format"; in Outlook, Settings ▸ Calendar ▸ Shared calendars ▸ Publish. Paste it under Nudges ▸ Link a calendar, and the buddy brings you a card a few minutes before each meeting. The link is only ever fetched, never shared.
How do I uninstall it?
Mac: quit it from the menu, then delete WorkKit Buddy from Applications and WorkKit Buddy.saver from /Library/Screen Savers. Windows: Settings › Apps › WorkKit Buddy › Uninstall. Linux: sudo apt remove workkitbuddy, or delete the folder you unpacked. Your settings and custom characters are kept unless you delete them yourself.