Getting Started

Quickstart: 1-Minute Integration Guide

Follow this guide to add ReMOAT to any web application in 3 simple steps.

Step 1: Install the SDK

Install via your preferred package manager or include the zero-dependency CDN script:

npm

BASH

npm install @remoat.dev/sdk

yarn

BASH

yarn add @remoat.dev/sdk

pnpm

BASH

pnpm add @remoat.dev/sdk

CDN

HTML

<script src="https://sdk.remoat.dev/remoat-sdk.js"></script>

Step 2: Initialize ReMOAT

Initialize ReMOAT with your Workspace API key (generate one in your ReMOAT Dashboard):

ES Modules

JAVASCRIPT

import ReMOAT from '@remoat.dev/sdk';

// Initialize with your API key
ReMOAT.init({
  apiKey: 'tpk_your_workspace_api_key',
  mode: 'floating', // 'floating' pill, 'hidden', or 'custom'
  redactSelectors: ['.credit-card-input', '[data-sensitive="true"]'],
  redactHeaders: true,
});

Next.js (App Router)

TYPESCRIPT

'use client';
import { useEffect } from 'react';
import ReMOAT from '@remoat.dev/sdk';

export function ReMOATProvider() {
  useEffect(() => {
    ReMOAT.init({
      apiKey: process.env.NEXT_PUBLIC_TELEPATH_KEY || 'tpk_your_key',
      mode: 'floating',
      redactSelectors: ['.credit-card-input', '[data-sensitive="true"]'],
      redactHeaders: true,
    });
  }, []);

  return null;
}

HTML Script Tag

HTML

<script>
  window.addEventListener('DOMContentLoaded', () => {
    if (window.ReMOATSDK) {
      ReMOATSDK.ReMOAT.init({
        apiKey: 'tpk_your_workspace_api_key'
      });
    }
  });
</script>

Step 3: Pair and Debug

Open your web app in any browser (Chrome, Safari iOS, Firefox, Android).
Tap the floating ReMOAT pill to reveal your 6-digit one-time PIN.
Open dashboard.remoat.dev on your workstation, enter the PIN, and inspect the remote page live!

🚀 Deploy ReMOAT in your project in under 60 seconds

Install @remoat.dev/sdk with zero server storage and sub-10ms WebRTC P2P DevTools streaming.

Launch Developer Console →