Start with one useful report
Choose your platform. Connect your app. Verify the evidence.
Crumb gives people a way to report a problem from inside your app, with a screenshot and bounded diagnostic evidence. Start with a report you submit yourself before adding optional collection.
Choose your quickstart
| Your app | Start here | Requirements |
|---|---|---|
| React Native or Expo | React Native quickstart | React Native 0.79+, iOS 15.1+, Android API 26+; Expo development build |
| Native iOS | iOS quickstart | iOS 15+; Swift Package Manager or CocoaPods |
| Native Android | Android quickstart | API 26+, Java 17; Maven Central |
Before you start
Create a project in your Crumb workspace and open its SDK setup. Copy the project write key and ingestion URL. Use your own values wherever a guide shows crumb_sdk_replace_me or https://api.example.com.
The write key belongs in the app and only permits ingestion. It cannot read reports or sign in to your account. Save it when it is first revealed; if you lose it, use the project's key controls to create a replacement.
Choose an environment such as development or production. Keep your first test clearly identified so you can find it in the dashboard.
What success looks like
- Open the reporter from a button.
- Check that the screenshot is useful and sensitive regions are masked.
- Describe a synthetic problem and submit it.
- Find the report in the matching dashboard project and environment.
A local submission and a successful upload are separate events. Reports saved offline remain queued across app restarts. Without an ingestion URL, they stay local.
Then add the context you need
- Screen context: the static app screen where a report or JavaScript failure happened.
- Logs and diagnostics: bounded evidence and honest availability states.
- JavaScript crashes: optional failure capture and recovery after relaunch.
- Privacy: masking, evidence controls and collection boundaries.
Features labelled Preview are implemented on the SDK's main branch but are not in the published 0.0.1-rc.3 packages. Check release availability before copying advanced examples.