Documentation

Local Pocket's documentation lives in the repository under docs/, next to the source. Reading it on GitHub guarantees you see the version that matches the code you have installed.

Quickstart

1. Download. Grab the signed DMG from /download; double-click to mount; drag Local Pocket to /Applications. Total time ≈ 30 seconds.
2. Open + sign in to your data. On first launch Local Pocket downloads its ~700 MB AI model in the background and walks you through a 5-step setup (Apple Calendar, Apple Contacts, Gmail, Apple Health, folders to index). Every connector is opt-in — skip any you don't want.
3. Ask anything. Press ⌘K from anywhere on macOS to open the Quick-Ask Panel, or click the menu-bar icon. Try "summarise tomorrow's meetings" or "what did Sarah and I agree on last week?" — answers come back with sources from your own data.

That's it. The app runs entirely on your Mac; no account, no API keys, no internet required after the first model download.

Common starting points

• Architecture →

  Module layout, runtime topology, data flow.

• Setup →

  Building from source — pyenv, .venv, ObjectBox, build_native.sh.

• Platform status →

  Live status of macOS, iOS, Android, Windows clients.

• Pairing →

  QR pairing protocol for cross-device sync.

• Audit log →

  Open audit findings tracked across the codebase.

• Go-to-market →

  Launch plan and release sequencing.

• Website spec →

  Spec for this site (yes, it self-references).

• Privacy policy (source) →

  Markdown source of /privacy.

• Terms (source) →

  Markdown source of /terms.

Other places to look

• Discussions — community Q&A, feature requests, share-your-config threads
• Issues — bug reports and roadmap labels
• CHANGELOG.md — release notes on GitHub