Docs

Choose Your Path

Pick the minimum CircleBox setup that matches your team stage.

Core Only

Use when you need local crash reconstruction in QA or on customer devices without backend integration.

  • CircleBoxSDK / circlebox-sdk
  • circlebox_flutter / circlebox-react-native

Core + Cloud

Use when you want managed ingestion, queue retry, and dashboard timelines.

  • Core packages above
  • CircleBoxCloud / circlebox-cloud
  • circlebox_cloud_flutter / circlebox-cloud-react-native
  • Ingest API key generated from /app/projects/*/keys after /app/onboarding

Core + Sentry/PostHog

Use when your team already depends on Sentry or PostHog and wants CircleBox context added there.

  • Core packages
  • Companion adapters only

Core + Cloud + Adapters

Use when you want both:

  • native-first CircleBox pipeline
  • forwarding to existing observability stack

This path is common during migration from single-vendor crash tooling.

Core + Self-Host (Optional Usage Beacon)

Use when you want CircleBox crash payloads in your own backend/storage while still optionally sending aggregate usage counters.

  • Configure cloud uploader endpoint to your own ingest API
  • Keep usage_beacon key optional and opt-in only
  • No vendor lock-in on raw crash report ownership
PreviousExport Formats and Crash Workflow NextRelease Matrix