Getting started

PulseRN combines a local debugger with the @pulse-rn/sdk package. Run the debugger as a packaged desktop application or launch the same interface in your browser. The SDK captures development events and sends them to PulseRN’s chronological timeline.

Prerequisites

• A React Native development build
• PulseRN running on the same computer as Metro
• Node.js 22.5 or newer when using the browser edition

Expo Go cannot load native MMKV integrations; use an Expo development build when your app uses MMKV.

1. Start PulseRN

Choose one of these local interfaces:

• Browser: with Node.js 22.5 or newer, run npx @maahibhama/pulsern. Keep the terminal open while debugging and press Ctrl+C to stop PulseRN.
• Desktop: choose a package from desktop installation or GitHub Releases, then open PulseRN. Preview builds are unsigned, so macOS Gatekeeper or Windows SmartScreen may show a warning.

The browser edition opens at http://localhost:3000 and uses the same default SDK port, 9090. See Run in a browser for Homebrew installation, custom ports, persistence, and security guidance.

2. Add the SDK

npm install @pulse-rn/sdk

Configure it once during development startup:

import { Platform } from "react-native";
import { ReactNativeDevTool } from "@pulse-rn/sdk";

if (__DEV__) {
  ReactNativeDevTool.configure({
    host: Platform.OS === "android" ? "10.0.2.2" : "127.0.0.1",
    port: 9090,
    appName: "MyApp",
    enableConsole: true,
    enableNetwork: true,
    enableErrors: true,
    enablePerformance: true,
    redaction: { fields: ["password", "token"] },
  }).connect();
}

Keep allowInProduction at its default value, false.

3. Run and verify

Start PulseRN before launching the app. Generate a console.log or network request. A connected device and its events should appear in the timeline.

Use 127.0.0.1 for the iOS Simulator and 10.0.2.2 for the Android Emulator. For an attached Android device, reverse the port:

adb reverse tcp:9090 tcp:9090

For a physical device over Wi-Fi, enable authenticated LAN access in PulseRN Settings and follow Connections and secure pairing. LAN connections require a one-time pairing code or a previously issued reconnect token.

Troubleshooting

• No device appears: confirm PulseRN is running, the port is 9090, and the app is a development build.
• Android cannot connect: use 10.0.2.2 for an emulator or configure adb reverse for a USB device.
• Physical device cannot connect: enable LAN access, use the computer’s LAN IP, and create a fresh pairing code.
• Duplicate network events: avoid enabling an Axios interceptor for requests already captured by the global fetch/XHR instrumentation.

Next steps

Continue with the complete SDK setup, explore the inspectors, or learn how to use the timeline.