Everything below assumes you've already done the README quick start. If you only read one page here, make it the threat model, especially before you put the dashboard on your LAN.
Start here
- Threat model and safe operation — read before turning on LAN mode
Getting started
Operating the SDK
- Build variants and production safety
- LAN permission and troubleshooting — includes open access and the opt-in session-code connect flow
- Background keep-alive — the default foreground service that keeps the server alive while the host app is backgrounded
- FAQ / troubleshooting
- Event storage and retention
Inspectors
- Network inspector — including capture-exclusion rules
- Network stack adapters — OkHttp, Retrofit, Ktor, and writing your own
- WebSocket inspector
- MQTT capture — Eclipse Paho adapter and the
MQTTcapture category - Composer and mocks
- Push
- State and feature flags
- Remote Config
- Location pings
- Crash and ANR capture — all-thread dumps, breadcrumbs,
CrashPolicy, and the Crashes surface on both web and Android - Data inspectors, exports, and the More screen — preferences, database, files, the device's More screen, and HAR/Postman/session-ZIP/evidence-bundle exports
- Evidence tray and bug reports — flagging, snapshot-at-flag, the evidence bundle, and the Markdown/Jira/GitHub clipboard formats
Security
- Threat model and safe operation — read the screenshot section before turning on
ScreenshotPolicy.enabled - Security and redaction
- Vulnerability reporting
Design
- Dashboard design spec — UI tokens, components, constraints, and all screens
Reference
- Protocol reference — the embedded server's REST/WebSocket wire protocol
- API reference is generated from source via Dokka, not hand-written (hand-written prose would
drift out of sync with the code). Run
./gradlew dokkaGenerateand openbuild/dokka/html/index.html. Coverssdk:api— the module with a committed public API surface (see the rootapiValidationblock).
Contributing / releasing