Getting Started

Snapbug now has a browser-first setup:

  1. Add the Snapbug SDK to your app.
  2. Open the Chrome Extension and create a room code.
  3. Connect the app to the extension over WebRTC.
  4. Optionally run the local service if you want Ask AI and QA analysis workflows.

Recommended path

  • Chrome Extension is the default product path for inspection and bug reporting.
  • Local service is optional and only needed for AI workflows (Ask AI and QA analysis).
  • Desktop app is a fully supported alternative to the extension — a standalone window with the local service bundled in. Pick whichever fits your workflow.

Android install

Add the runtime artifact in debug and the no-op artifact in release:

dependencies {
    debugImplementation("ai.snapbug:snapbug:0.1.0")
    releaseImplementation("ai.snapbug:snapbug-no-op:0.1.0")
}

Initialize the SDK in your launcher Activity:

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        Snapbug.start(this)
    }
}

One line enables all plugins — network, database, analytics, crash reporter, logs, deep links, device info — and the bubble overlay. You can also pass configuration if you need to tune plugins or overlay settings:

Snapbug.start(this) {
    overlay = OverlayMode.BUBBLE
    crashReporter { catchFatalErrors = true }
    debugFeedback { screenNameProvider = { "Home" } }
}

Connect to the Chrome Extension

  1. Install the Snapbug Chrome Extension.
  2. Open the extension and create a room code.
  3. In your app, open the Snapbug overlay.
  4. Enter or scan the room code.
  5. Wait until the connection state becomes Connected.

This path does not require ADB, port forwarding, or a shared Wi-Fi network.

Optional: local service

Install the local service only if you need AI actions such as Ask AI or QA analysis (AI-generated steps to reproduce and QA notes for bug reports).

brew install snapbug-ai/tap/snapbug
snapbug serve

The service exposes:

  • http://localhost:9090 for Chrome Extension readiness and AI endpoints
  • ws://localhost:9023 and http://localhost:9024 for direct localhost transport

Verify it is running with snapbug status.

Platform notes

  • Android: fully supported.
  • iOS: supported via the Swift package — import Snapbug then Snapbug.start(). See iOS SDK.
  • Flutter and React Native: official plugins on top of the native SDK — initialize the native SDK in Application / AppDelegate, then call Snapbug.start() on the Dart/JS side. See Flutter and React Native.
  • Desktop app: a standalone inspector window (bundles the local service) — an alternative to the Chrome Extension on macOS, Windows, and Linux.

Next steps

Chrome Extension