Skip to content
TraceItX Docs
Documentation

Install the SDK

Every SDK produces the identical envelope, so your receiver code never changes when you add a platform.

Pick your platform below. For the full list of supported screens — including the TV and connected platforms — see the SDKs and platforms pages.

SDK versions move quickly and are kept roughly in lockstep. The package managers below resolve the current release; pin a version from the GitHub releases if you prefer.

React (web)

npm i @traceitx/react
import { TraceItXProvider } from '@traceitx/react';

<TraceItXProvider config={{ apiKey: 'txx_live_…' }}>
  <App />
</TraceItXProvider>

Open the reporter from anywhere inside the provider with useTraceItX().open().

React Native

npm i @traceitx/react-native

Supports the New Architecture (Fabric) and Hermes on RN ≥ 0.84, including react-native-tvos. Wrap your root in TraceItXProvider and call useTraceItX().open() — the same API as the web SDK.

iOS · iPadOS · tvOS (Swift)

The iOS SDK is distributed as a binary via Swift Package Manager from the public releases repository (iOS 15 / tvOS 15+):

// Package.swift
.package(url: "https://github.com/scriptx-com/traceitx-releases", from: "0.6.0")

Then add the TraceItXKit product to your target. A CocoaPods TraceItX pod is also available.

Android (Kotlin)

Add the Maven coordinate to your module’s Gradle build (API 24+):

// build.gradle.kts
implementation("com.traceitx:core:0.6.0")
implementation("com.traceitx:reporter-ui:0.6.0")

Initialise once with your SDK key, then open the reporter from your own trigger UI — mirroring the JS SDKs’ open() call.

Configuration that applies everywhere

  • SDK key — required; authenticates to the ingest API.
  • Capture toggles — choose what each report includes: screenshot, UI tree, focus, console logs, network. The receiver always learns what was and wasn’t captured.
  • Sensitive content — mark subtrees (or secure text fields) as sensitive and their descendants are omitted from the captured UI tree — a privacy invariant enforced by every SDK.
  • User context — optionally attach an end-user id, email, or display name so reports are attributable.
  • Screen tracking — the one thing that is not uniform: what is captured automatically depends on whether the platform has a screen primitive to observe. See screen & navigation tracking.
One schema, every platform. No matter which SDK sends a report, your receiver gets the same envelope — so triage prompts and integrations are written once.