👋 Welcome!

Let's get you up and running with Highlight. We should be done in less than 2 minutes.

Installing the SDK

Install highlight.run using your package manager.

# with npm
npm install highlight.run

# with yarn
yarn add highlight.run

Initialize

Initialize Highlight where your application starts.

import { H } from 'highlight.run'

H.init(
	'<YOUR_PROJECT_ID>', // Get your project ID from https://app.highlight.run/setup
)

Example

import { H } from 'highlight.run'
import { createApp } from 'vue'
import App from './App.vue'

H.init('9me23yd2') // Get your project ID from https://app.highlight.run/setup

createApp(App).mount('#app')

Verify

Start your app, go to it in the browser, then click around. Highlight will be recording your session and it will show up on https://app.highlight.run/sessions a few seconds after recording has started.