Documentation
The documentation lives with the source, so it changes in the same commit as the code it describes. Start with the usage guide to run the platform, or the plugin API to extend it.
Guides
| Document | For |
|---|---|
| Usage guide | Every screen and workflow: vault, connections, terminal, SFTP, forwarding, sync, teams, audit |
| Security model | The precise boundary and its gaps |
| Sync server | Installing, running and backing up xqsyncd |
| Environment workarounds | Driver and system-library failures that look like application bugs |
For developers
| Document | For |
|---|---|
| Plugin API | JSON-RPC methods, session lifecycle, binary channel bus |
| Plugin manifest | Every field of plugin.json and each capability |
| Architecture | Layers, dependency rules, extension points |
| Decision records | Why the code is shaped the way it is |
| Contributing | Pull request process and style |
Common problems
Host key verification failed
The server's key differs from the one stored. If the change is expected, such as a reinstall, choose Replace in the prompt or remove the entry in Known Hosts. Otherwise do not connect.
The app does not start on Windows
The WebView2 runtime is missing. Use the -portable-webview2 archive, which bundles it.
“xQuakShell is already running”
Only one copy runs per folder, to protect the vault. A second start brings the open window forward; if that window is still starting or closing, wait a few seconds.
Forgotten master password
Type the recovery key in the password field, then set a new password. Without both, the vault cannot be opened by anyone; delete data/ to start over.
Community
Questions and announcements: Telegram channel. Bugs and requests: GitHub issues. Vulnerabilities: SECURITY.md, privately.