Documentation

Everything you need to install, configure, and get the most out of XKG Desktop.

🚀
Quick start
Install XKG Desktop on Linux, Windows, or macOS, set up the global shortcut, and capture your first note in under 5 minutes.
Read on GitHub →
🔄
Cross-device sync
Set up cluster-hub, configure JSONL bridge, and see your captures on your phone, tablet, and other desktops.
Read the guide →
💾
Installation
Per-platform install steps: dpkg, rpm, AppImage, NSIS, MSI, DMG. Plus silent install for enterprise deployment.
Read the guide →
🏗️
Architecture
How the global shortcut, SQLite storage, FTS5 search, autostart, and the cluster-hub sync layer fit together.
Read on GitHub →
📱
Mobile (xkg-mobile)
Flutter app docs: Android, Linux, and Windows bundles, how the JSONL bridge works, and how to read captures on the go.
Read on GitHub →
🌐
End-to-end workflow
Walk through: capture on desktop → see on mobile → review on any device. The complete cross-device flow with diagrams.
Read the guide →
📋
Changelog
Every release: new features, bug fixes, breaking changes. See what shipped in v0.1.0 and what's coming next.
View changelog →
💬
Support
Common questions, troubleshooting, contact info, and how to file a useful bug report.
Get support →