Yappy documentation
Yappy is a macOS menubar app with two keys. These pages cover installing it, setting it up, and fixing it when macOS gets in the way.
Start here
- Quickstart — download, permissions, first dictation
- Dictation — the Right ⌥ key, hands-free mode, personas
- Agent Mode — the Right ⌘ key, what it can do, where it stops
- LLM backends — local, subscription, and API options
- Configuration — every key in
~/.yappy/config.json - Privacy model — exactly what leaves the machine
- Troubleshooting — permissions, hotkeys, silence
- Changelog — what shipped and when
Building against Yappy
- Developer portal — REST, GraphQL, MCP, auth, sandbox
- API reference — endpoints, parameters, response shapes
- OpenAPI 3.1 spec — the machine-readable contract
Requirements
macOS 13 (Ventura) or later on Apple Silicon — M1 or newer. Yappy is distributed as a notarized .dmg from this site and updates itself in place. It is not on the Mac App Store: the Accessibility permission that lets the agent drive your apps cannot coexist with App Store sandboxing.
The two keys
| Hold | What happens |
|---|---|
| Right ⌥ (Option) | You talk, it types. Clean, formatted text lands wherever your cursor is. |
| Right ⌘ (Command) | You talk, it does. The agent reads the screen, clicks, fills forms, and reports back. |
Both keys are configurable — see configuration.
Reading this as an agent
Every page here has a markdown twin: append .md to the URL, or fetch the whole set from [/docs/llms.txt](https://yappy.biz/docs/llms.txt). The same content is queryable as MCP tools at https://yappy.biz/mcp (search_docs, get_doc).